CSM follows a scaled trunk branching strategy where short-lived branches are created off of the main branch. When coding is complete, the branch is merged back into main after being approved in a pull request code review.
Branch Type | Example | Comment |
---|---|---|
main | main | |
Release | release-1.0 | hotfix: release-1.1 patch: release-1.0.1 |
Feature | feature-9-olp-support | "9" referring to GitHub issue ID |
Bug Fix | bugfix-110-remove-docker-compose | "110" referring to GitHub issue ID |
- Fork the repository.
- Create a branch off of the main branch. The branch name should follow branch naming convention.
- Make your changes and commit them to your branch.
- If other code changes have merged into the upstream main branch, perform a rebase of those changes into your branch.
- Open a pull request between your branch and the upstream main branch.
- Once your pull request has merged, your branch can be deleted.