speckit-branch-convention-configure
Skill107 starsChanged 9 months agoMITView on GitHub
Set up branch and folder naming rules for the current project
In this repository48 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- commitSkill
- create-pull-requestSkill
- create-release-branchSkill
- create-release-notesSkill
- handle-pr-reviewSkill
- qlty-checkSkill
- record-code-review-feedbackSkill
- record-spec-feedbackSkill
- recreate-test-dbSkill
- redmine-playwright-loginSkill
- regression-checkSkill
- rubocopSkill
- speckit-agent-context-updateSkill
- speckit-analyzeSkill
- speckit-branch-convention-renameSkill
- speckit-branch-convention-validateSkill
- speckit-checklistSkill
- speckit-clarifySkill
- speckit-constitutionSkill
- speckit-convergeSkill
- speckit-git-commitSkill
- speckit-git-featureSkill
- speckit-git-initializeSkill
- speckit-git-remoteSkill
- speckit-git-validateSkill
- speckit-implementSkill
- speckit-planSkill
- speckit-review-codeSkill
- speckit-review-commentsSkill
- speckit-review-errorsSkill
- speckit-review-runSkill
- speckit-review-simplifySkill
- speckit-review-testsSkill
- speckit-review-typesSkill
- speckit-specifySkill
- speckit-tasksSkill
- speckit-taskstoissuesSkill
- speckit-token-budget-compactSkill
- speckit-token-budget-conciseSkill
- speckit-token-budget-scopeSkill
- speckit-token-budget-usageSkill
- speckit-wiki-ingestSkill
- speckit-wiki-initSkill
- speckit-wiki-lintSkill
- speckit-wiki-querySkill
- speckit-wiki-statusSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 28
Verify a spec-kit project exists by checking for .specify/ directory
- Very specific: line 29
Check if a convention config already exists at .specify/branch-convention.yml
- Distinctive: line 66
Available tokens: Document these template tokens for patterns:
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Branch Convention Configure Skill
Configure Branch Convention
Set up configurable naming rules for how /specify creates Git branches and spec folder names. Supports ticket IDs, GitFlow prefixes, date formats, and custom patterns.
User Input
$ARGUMENTSYou MUST consider the user input before proceeding (if not empty). The user may specify a preset (e.g., "gitflow", "ticket", "date") or provide custom patterns directly.
Prerequisites
- Verify a spec-kit project exists by checking for
.specify/directory - Check if a convention config already exists at
.specify/branch-convention.yml
Outline
Determine convention type: Based on user input or interactive selection:
Preset Branch Pattern Folder Pattern Example Branch Example Folder default{seq}-{kebab}{seq}-{kebab}003-user-auth003-user-authgitflow{type}/{seq}-{kebab}{seq}-{kebab}feat/003-user-auth003-user-authticket{ticket}-{kebab}{ticket}-{kebab}PROJ-142-user-authPROJ-142-user-authdate{date}-{kebab}{date}-{kebab}20260408-user-auth20260408-user-authcustomUser-defined pattern User-defined pattern — — Collect configuration: Build the convention config with these fields:
# .specify/branch-convention.yml convention: branch_pattern: "{type}/{seq}-{kebab}" folder_pattern: "{seq}-{kebab}" type_prefix: feature: "feat" bugfix: "fix" hotfix: "hotfix" refactor: "refactor" docs: "docs" default_type: "feat" seq_padding: 3 seq_start: 1 date_format: "YYYYMMDD" ticket_pattern: "[A-Z]+-[0-9]+" max_length: 60 separator: "-" lowercase: trueAvailable tokens: Document these template tokens for patterns:
Token Description Example {seq}Zero-padded sequence number 003{kebab}Kebab-case feature summary (2-4 words) user-auth-flow{ticket}Ticket/issue ID (e.g., JIRA, Linear) PROJ-142{date}Date in configured format 20260408{type}Branch type prefix from type_prefix map feat{summary}Raw feature summary (spaces allowed) user auth flow- Write configuration: Save the convention to
.specify/branch-convention.yml - Validate existing branches (optional): If branches already exist, check them against the new convention and report any non-compliant ones.
- Report: Output a summary:
- Convention type selected
- Branch pattern and folder pattern configured
- Example branch name using the new convention
- Number of existing branches that comply / do not comply
- Suggest next step:
/speckit.branch-convention.validateto check compliance, or/speckit.specifyto create a new feature using the convention
Rules
- Never overwrite without confirmation — if
.specify/branch-convention.ymlalready exists, show current config and ask before replacing - Branch and folder patterns are independent — branch may include type prefix (
feat/) while folder stays flat - Backward compatible — if no convention is configured, spec-kit default behavior (
{seq}-{kebab}) applies - Validate patterns — ensure configured patterns produce valid Git branch names (no spaces, no special chars except
/,-,_) - Preserve existing numbering — sequence numbers continue from the highest existing branch number
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

