To ensure consistency and clarity in our Git workflow, we follow a strict branch naming convention:
feature/feature-name: For new feature development- Example:
feature/user-authentication
- Example:
bugfix/bug-description: For fixing non-critical bugs- Example:
bugfix/login-error
- Example:
hotfix/critical-fix: For urgent production fixes- Example:
hotfix/security-patch
- Example:
release/x.y.z: For preparing new releases- Example:
release/1.2.0
- Example:
docs/description: For documentation changes- Example:
docs/readme-update
- Example:
We follow the Conventional Commits specification to maintain readable and consistent commit history.
Examples:
feat: add login functionalityfix: handle null pointer on user servicedocs: update README with usage examplesrefactor: simplify validation logictest: add unit tests for user servicechore: update dependencies
All changes must go through a Pull Request (PR) review before being merged into the dev branch.
- Create a new branch following the naming conventions, or update in a created branch.
- Make your changes and commit using Conventional Commits.
- Push the branch.
- Open a Pull Request on GitHub.
- Wait for the approval before merging.