Whenever working on a new change, always branch out and keep publishing your changes from time to time to avoid data loss. We try to follow linear commit history, so always use rebase instead of merge.
Naming a branch depednds on the changes you are working on and the type of changes.
- Following branch naming patterns are recommended:
| Type | Pattern | Example |
|---|---|---|
| New features | feature/<feature-name> |
feature/intorduce-storage |
| Bug Fix | fix/<fix-name> |
fix/auth-error |
| Hotfix (urgent bug fuxes) | hotfix/<fix-name> |
hotfix/docusign-regression |
| Maintenance | maintenance/<maintenance-name> |
maintenance/run-integration-tests-in-workflows |
- Ensure branch name represents what the branch is about (avoid using names like
fix/bug-fix, etc)
- Ensure PR title hints the changes made in head branch appropriately
- Ensure PR desciption explains all the changes made in head branch in detail
- Ensure all commits are linear (no merge commits)
- Use
Rebase and Mergeoption to land PRs once all checks are approved
Follow this article on how to write your commit messages