Skip to content

Git workflow

Juncheng E edited this page Aug 1, 2023 · 2 revisions
  1. Branch from the current main branch
  2. Identify the official repo as upstream: git remote rename origin upstream
  3. Develop into the newly created branch
  4. Create appropriate unit tests in tests
  5. Test current development as indicated in the testing document.
  6. git pull upstream main
  7. git rebase -i main w.r.t. current main branch to include the latest updates and squashing commits to a minimum. See also here.
  8. (Optional) Add your own forked repo as a new remote, we name it "FORKED" here, and please replace "GITLINK" with the link of the repo you would like to add: git remote add FORKED GITLINK.
  9. Push your BRANCH to the upstream repo: git push -f upstream BRANCH or the forked repo: git push -f FORKED BRANCH.
  10. Create a pull request (PR) to the main branch on the GitHub page.
  11. PR should be reviewed and approved and be passing all CI tests.
  12. If passing all tests, Choose Rebase and merge to merge the PR with no further squashing.
Clone this wiki locally