Branch Conventions

Branch Prefixes

1. feature/

   This prefix is used for new features that are being added to the codebase. The feature branch typically begins its lifecycle from the main branch or a designated development branch.

   Format: feature/<short-description>

   Examples:

   • feature/healthcard-storage
   • feature/text-to-speech-service

2. fix/

   This prefix is used for branches that fix bugs, application errors, or vulnerabilities. The fix branch typically begins its lifecycle from the main branch or a designated development branch.

   Format: fix/<short-description>

   Examples:

   • fix/contact-repository-inconsistencies
   • fix/auth-not-persistent

3. refactor/

   This prefix is used for tasks that involve maintenance or improvements to the codebase that don’t add new features or fix bugs. It can include things like refactoring or updating dependencies.

   Format: refactor/<short-description>

   Examples:

   • refactor/improve-ui-structure
   • refactor/centralize-theme-colors

4. ci/

   This prefix is used exclusively for CI/CD workflows. Branches with the ci/ prefix should be used to modify, test, and troubleshoot different workflow configurations without affecting other branches.

   Format: ci/<short-description>

   Examples:

   • ci/integrate-sonarcloud
   • ci/trigger-only-on-pr

5. release/

   This prefix is used for branches that are preparing a new release. Release branches help stabilize code for deployment and allow final bug fixes or documentation updates before going live.

   Format: release/<version-number>

   Examples:

   • release/1.0.0
   • release/2.0.0

Conclusion

Adhering to these branch naming conventions will help keep the codebase organized, improve collaboration, and make it easier to track the status and purpose of each branch. Please ensure you follow these guidelines whenever creating a new branch.