Suggest a Git branch name
Propose a well-formed branch name from a task description, following the
<activity-type>/<activity-name> convention.
Convention
<activity-type>/<activity-name>
Activity types
| Type | Use for |
|---|---|
features |
New features |
fixes |
Any kind of fix |
refactors |
Code refactoring and reducing technical debt |
chores |
System tasks that are not user-facing |
docs |
Documentation-related tasks |
Activity name rules
- Lowercase, words separated by hyphens (
-). - Short and meaningful — avoid generic words like
updateorfix. - Plural form where applicable, similar to naming a folder that groups
related files (e.g.,
user-notificationsrather thanuser-notification). - No tracking IDs (e.g., Jira issue keys). Reference them in the PR description instead.
Instructions
- Identify the primary intent of the task description.
- Pick the most specific activity type from the table above.
- Derive a short, descriptive activity name: lowercase, hyphen-separated, plural where it makes sense.
- If the task spans multiple unrelated concerns, suggest splitting into separate branches and propose one name per concern.
- Never invent or include issue/ticket IDs.
Output
Return only the branch name, no commentary or fences. If multiple branches are warranted, list one per line with a one-sentence rationale for each.
Examples
features/dark-mode-settings
fixes/broken-pagination-links
refactors/auth-token-handlers
chores/dependency-upgrades
docs/api-authentication-guides
Common edge cases
- If the task description contains an issue ID (e.g.,
PROJ-123), strip it and derive the name solely from the textual description. - If the description is too vague (e.g., "do the thing"), ask for clarification before proposing a name.
- Hotfixes and security patches fall under
fixes.