Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.97 KB

BRANCH_NAMING_CONVENTIONS.md

File metadata and controls

50 lines (33 loc) · 1.97 KB
Raw

Branch Naming Conventions

To maintain a clean and organized repository, it's essential for all contributors to adhere to a consistent set of branch naming conventions. These conventions help streamline workflows, simplify tracking of feature development, bug fixes, and releases, and improve collaboration across the team.

1. Feature Branches

  • Prefix: feature/
  • Purpose: New features and enhancements.
  • Example: feature/login-authentication

2. Bugfix Branches

  • Prefix: bugfix/ or fix/
  • Purpose: Bug fixes.
  • Example: bugfix/login-error

3. Release Branches

  • Prefix: release/
  • Purpose: Preparing new product releases.
  • Example: release/1.2.0

4. Hotfix Branches

  • Prefix: hotfix/
  • Purpose: Urgent fixes to the live production environment.
  • Example: hotfix/1.2.1

5. Improvement or Refactor Branches

  • Prefix: improvement/ or refactor/
  • Purpose: Code refactoring or performance improvements.
  • Example: improvement/load-time-optimization

6. Documentation Branches

  • Prefix: docs/ or documentation/
  • Purpose: Documentation updates and improvements.
  • Example: docs/api-documentation-update

Naming Best Practices

  • Conciseness and Descriptiveness: Branch names should be brief yet descriptive enough to convey the branch's purpose at a glance.
  • Word Separation: Use hyphens (-) to separate words in the branch name.
  • Avoid Special Characters: Use only alphanumeric characters and hyphens to prevent issues with tooling or command line usage.
  • Issue or Ticket Numbers: Include the related issue or ticket number for easy reference, e.g., feature/123-add-search-functionality.

Conclusion

Adhering to these conventions will facilitate a more efficient and organized workflow within our team. It's crucial for all team members to follow these guidelines for branch naming to ensure our repository remains clean and our collaboration is seamless.