Branch Naming Convention

To ensure consistency and improve project management, follow the branch naming convention below.

Basic Rules

Only the following branch naming patterns are permitted. Other naming conventions are prohibited.

1. \p{issue_id} = [0-9]+ : GitHub Issue ID
2. \p{summary} = [a-z0-9-]+ : Brief description in English
3. \p{date(yyyymmdd)} = [0-9]{8} : Creation date (start date of work)
4. \p{commit_hash} = [a-f0-9]{7,40} : Commit hash

Feature

1. For feature development
2. Use for developing or improving features

feature/{issue_id}-{summary}-{date(yyyymmdd)}

• Example: issue ID is 10

feature/10-add-api-nameabc-20250316

Bugfix

1. For production environment bug fixes
2. Use to fix bugs occurring in the production environment

bugfix/{issue_id}-{summary}-{date(yyyymmdd)}

• Example: issue ID is 15

bugfix/15-fix-login-error-20250316

Hotfix

1. For urgent fixes
2. Use for critical bugs requiring immediate resolution in the production environment

hotfix/{issue_id}-{summary}-{date(yyyymmdd)}

• Example: issue ID is 20

hotfix/20-critical-security-patch-20250316

Revert

1. For reverting previous changes
2. Use when reverting a previous commit

revert/{commit_hash}-{date(yyyymmdd)}

• Example: commit hash is abcd123

revert/abcd123-20250316

Allowed Characters

1. Lowercase alphabet (a-z)
2. Numbers (0-9)
3. Hyphen (-)

Always use kebab-case (connecting words with hyphens).

Prohibited Characters

1. Uppercase alphabet (A-Z)
2. Spaces ( )
3. Underscores (_)
4. Other symbols (!, @, #, $, %, ^, &, *, (, ), etc.)

Notes

1. Keep branch names clear and concise.
2. Do not create branches without an issue; always create an issue before creating a branch.
3. Changing branch names after creation is prohibited.