10. Basic Steps Working with the HAFS Repository

(Please see the Prerequisites for Working with the HAFS Repository)

  1. Fork the HAFS repository and clone the forked repository locally

  2. Branch from the develop branch for new developments

  1. Create a feature branch, add development, complete testing

  2. Commit changes into the local branch and push the local branch to your personal fork

  1. Submit a PR (Pull Request) to request a code review and merge with the authoritative HAFS repository

10.1. Fork the HAFS repository and clone the forked repository locally

  1. Navigate to https://github.com/hafs-community/HAFS, locate and click on the “fork” button towards the top right of the page.

  2. Clone your new created HAFS fork to get a local copy, e.g.,

    git clone --recursive https://USERNAME@github.com/USERNAME/HAFS.git

Hint: GitHub forking projects

10.2. Branch from the develop branch for new developments

  1. Check out the develop branch

    git checkout develop

  2. Create a new branch from the develop branch

    git checkout -b feature/mybranch

  3. Update the submodules

    If there are changes for the URLs of the submodules, run this command to update the remotes of the submodules

    git submodule sync --recursive

    Note: every time after your clone a git repository or check out a new branch, if submodule changes are expected, you need to update the submodules properly by

    git submodule update --init --recursive

  4. Make modifications and commit your changes locally

    vi newcode
git add newcode
git commit -m “Add newcode”

  5. Push your changes to your GitHub HAFS fork

    git push origin feature/mybranch

10.3. Submit a pull request for inclusion into the authoritative HAFS repository

To propose changes for inclusion into the authoritative HAFS repository, you need to create a pull request.

  1. Navigate to https://github.com/hafs-community/HAFS and click on ‘new pull request’

  2. Select ‘compare across forks’, set base repository to ‘hafs-community/HAFS’, base to ‘develop’, head repository to ‘YOUR_GITHUB_USERNAME/HAFS’, compare to ‘feature/mybranch’

  3. Add a descriptive title and short description in the text boxes

  4. If this were a real development, you would now click on ‘Create pull request’