Skip to content

3. Checking out code and making changes

GeorgeGayno-NOAA edited this page Oct 21, 2021 · 23 revisions
  • Create an issue so other developers and the repository manager are aware of your project.
  • Developers shall use their own fork to checkout code and make changes. Use the 'fork' button at the top right of this page to create your own fork. Some good references for forking are:
  • Following the Gitflow process, all code development must be done within your fork in 'feature' branches created off 'develop'. Under Gitflow, 'develop' is the main development trunk. All code development uses this branch for syncing and coordinating. For information on creating branches, see this Github help page.
  • As you commit updates to your branches, please reference the issue number in all commit messages. That will attach all commit messages to their issue. Example commit message: "Update x,y and z. This commit references issue #33"
  • We are a part of a big happy community of developers. So, the authoritative repository will be frequently updated with new capabilities and bug fixes. Therefore, you must keep your fork and branches up-to-date with the authoritative repository.
  • Keep your fork up-to-date with the authoritative repository.
    • git remote add upstream [email protected]:ufs-community/UFS_UTILS.git
    • git fetch upstream
    • git checkout 'develop' (your fork)
    • git merge upstream/develop
  • Once your fork is up-to-date with the authoritative repository, merge from 'develop' to your branches
    • git checkout your_branch
    • git --no-commit merge develop
    • Fix any conflicts, then commit.