Skip to content

Git Flow

Ben Watson edited this page Jun 15, 2022 · 15 revisions
  1. All new work should be done in a new feature branch either in this repo or in a contributor's personal fork of this repo.
  2. Be sure to update the docs/guides/local_installation.md for any references of the version with the newest, expected version.
    1. For example, if the current released version is 2.0.0 and you're making a PR expecting to release 2.0.1, then the docs/guides/local_installation.md should reflect this.
  3. When ready, the contributor should submit a PR from their feature branch (either in this repo or their fork) to the master branch, which then must pass all checks
  4. Another user should either approve the PR, reject the PR, or request changes
  5. Then, if the PR was approved, the contributor who submitted the PR should
    1. Merge the PR to master and run a git pull to update the master branch locally.
    2. Create a tag on the head of the master branch with git tag -a 'v1.0.0' -m 'tag description' where v1.0.0 is the version (with the v prefix), and tag description is a description of the changes in the new tag (Note: make this description meaningful because it will be used to automatically create a new release in Github)
    3. Push the new tag to this repo with git push origin --tags
    4. Wait for build automation to complete and edit the drafted release details as appropriate, then publish.
Clone this wiki locally