Labels / Branch Names

Last Updated: May 02, 2025

“Labels / Branch Names” are the identifiers used to categorize and distinguish different versions or variations of a project, product, or system. They provide a clear and concise way to track changes, manage parallel development efforts, and organize related content.

Preview

General Principles:

Clarity: The prefix should immediately convey the branch’s purpose.
Conciseness: Keep prefixes short to maintain readability.
Consistency: Adhere to the convention across the team and project.
Lowercase: Use lowercase for simplicity and to avoid case-sensitivity issues.
Hyphens: Separate words within the description with hyphens (-).

Comprehensive List of Branch Name Prefixes:

feat/:
- #1d76db (Blue)
- For new features, enhancements, or significant additions to the application.
- Examples: feature/user-authentication, feature/shopping-cart-v2
bugfix/:
- #d93f0b (Red)
- For addressing and resolving specific bugs or defects.
- Examples: bugfix/login-error, bugfix/order-processing-crash
hotfix/:
- #B60205 (Dark Red)
- For urgent fixes to critical issues in production. These branches are typically short-lived and require immediate deployment.
- Examples: hotfix/security-vulnerability, hotfix/data-loss-bug
refactor/:
- #f29513 (Orange)
- For code restructuring, cleanup, or internal improvements that don’t change external behavior. Examples: refactor/database-schema, refactor/modularize-payment-service
perf/:
- #6f42c1 (Purple)
- Specifically for branches focused on improving the performance of the application (e.g., speed, efficiency, resource usage).
- Examples: performance/optimize-api-queries, performance/reduce-bundle-size
a11y/:
- #8250df (Medium Purple)
- For changes aimed at improving the accessibility of the application for users with disabilities.
- Examples: a11y/add-aria-labels, a11y/improve-keyboard-navigation
docs/:
- #0052cc (Dark Blue)
- For changes related to documentation (e.g., user manuals, API documentation).
- Examples: docs/update-readme, docs/add-api-documentation
content/:
- #e6d017 (Yellow)
- If you have content-heavy applications (e.g., CMS), you might use this for content updates.
- Examples: content/update-about-us, content/add-blog-post
test/:
- #009800 (Green)
- For changes specifically related to adding, modifying, or improving tests. Examples: test/add-unit-tests, test/e2e-testing-setup
chore/:
- #0b02d9 (Darker blue)
- Relates to maintenance or administrative work. For changes related to infrastructure or deployment configuration. Use this cautiously as these changes can have broad impacts.
- Examples: chore/update-deployment-script, chore/configure-database-connection

Markdown Version

**General Principles:**

* **Clarity:** The prefix should immediately convey the branch's purpose.
* **Conciseness:** Keep prefixes short to maintain readability.
* **Consistency:** Adhere to the convention across the team and project.
* **Lowercase:** Use lowercase for simplicity and to avoid case-sensitivity issues.
* **Hyphens:** Separate words within the description with hyphens (`-`).

**Comprehensive List of Branch Name Prefixes:**

* **`feat/`:**
  * `#1d76db` (Blue)
  * For new features, enhancements, or significant additions to the application.
  * Examples: `feature/user-authentication`, `feature/shopping-cart-v2`
* **`bugfix/`:**
  * `#d93f0b` (Red)
  * For addressing and resolving specific bugs or defects.
  * Examples: `bugfix/login-error`, `bugfix/order-processing-crash`
* **`hotfix/`:**
  * `#B60205` (Dark Red)
  * For urgent fixes to critical issues in production. These branches are typically short-lived and require immediate deployment.
  * Examples: `hotfix/security-vulnerability`, `hotfix/data-loss-bug`
* **`refactor/`:**
  * `#f29513` (Orange)
  * For code restructuring, cleanup, or internal improvements that don't change external behavior.

    Examples: `refactor/database-schema`, `refactor/modularize-payment-service`
* **`perf/`:**
  * `#6f42c1` (Purple)
  * Specifically for branches focused on improving the performance of the application (e.g., speed, efficiency, resource usage).
  * Examples: `performance/optimize-api-queries`, `performance/reduce-bundle-size`
* **`a11y/`:**
  * `#8250df` (Medium Purple)
  * For changes aimed at improving the accessibility of the application for users with disabilities.
  * Examples: `a11y/add-aria-labels`, `a11y/improve-keyboard-navigation`
* **`docs/`:**
  * `#0052cc` (Dark Blue)
  * For changes related to documentation (e.g., user manuals, API documentation).
  * Examples: `docs/update-readme`, `docs/add-api-documentation`
* **`content/`:**
  * `#e6d017` (Yellow)
  * If you have content-heavy applications (e.g., CMS), you might use this for content updates.
  * Examples: `content/update-about-us`, `content/add-blog-post`
* **`test/`:**
  * `#009800` (Green)
  * For changes specifically related to adding, modifying, or improving tests.

    Examples: `test/add-unit-tests`, `test/e2e-testing-setup`
* **`chore/`:**
  * `#0b02d9` (Darker blue)
  * Relates to maintenance or administrative work. For changes related to infrastructure or deployment configuration. Use this cautiously as these changes can have broad impacts.
  * Examples: `chore/update-deployment-script`, `chore/configure-database-connection`