Skip to content

docs: update branch naming convention from issue/ to feat/ (#44) - #45

Merged
tetsuh merged 1 commit into
mainfrom
feat/44-update-branch-naming-convention
Jul 7, 2026
Merged

docs: update branch naming convention from issue/ to feat/ (#44)#45
tetsuh merged 1 commit into
mainfrom
feat/44-update-branch-naming-convention

Conversation

@tetsuh

@tetsuh tetsuh commented Jul 7, 2026

Copy link
Copy Markdown
Owner

Closes #44

Changes

  • docs/development_workflow.md §1: branch name rule changed from issue/<number>-... to feat/<number>-...
  • AGENTS.md: absolute rules summary updated accordingly

Verification

git grep "issue/<" -- docs/ AGENTS.md
# no output

Scope note

docs/07_issue_breakdown.md does not contain branch-name examples, so no changes were needed there.

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ec1684c8-aa1e-49a5-bff3-64e8ffb140de

📥 Commits

Reviewing files that changed from the base of the PR and between 6fb8f99 and 96a71d1.

📒 Files selected for processing (2)
  • AGENTS.md
  • docs/development_workflow.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated branching examples to use a feat/<number>-<short-kebab-description> format.
    • Kept the existing PR closing reference format unchanged.
    • Aligned workflow guidance with the new branch naming convention.

Walkthrough

Two documentation files were updated to change the branch naming convention example from issue/<n>-<short-kebab-description> to feat/<n>-<short-kebab-description>, affecting AGENTS.md and docs/development_workflow.md.

Changes

Branch naming convention update

Layer / File(s) Summary
Branch naming examples updated
AGENTS.md, docs/development_workflow.md
Branch name format examples changed from issue/<n>-... to feat/<n>-... in both the AI agent rules and the trunk-based workflow documentation.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Related issues: #44 (docs: update branch naming convention from issue/ to feat/)

Suggested labels: documentation

Suggested reviewers: tetsuh

🐰 Poem

A rabbit hops through docs anew,
Swapping "issue" for "feat" on cue,
One small word, a tidy trace,
Branch names now in proper place,
Hop hop, convention passes through! 🐇

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/44-update-branch-naming-convention

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

- Change branch name rule in docs/development_workflow.md §1
- Update AGENTS.md absolute rules summary
- No occurrences of issue/<n>-... remain in docs/ or AGENTS.md
@tetsuh
tetsuh force-pushed the feat/44-update-branch-naming-convention branch from a3d4fd2 to 96a71d1 Compare July 7, 2026 08:36
@tetsuh tetsuh self-assigned this Jul 7, 2026
@tetsuh
tetsuh merged commit 22913c3 into main Jul 7, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: update branch naming convention from issue/ to feat/

1 participant