Skip to content

docs(readme): name branches <type>/<issue>-<slug> - #3

Merged
johantor merged 2 commits into
mainfrom
docs/branch-naming
Oct 24, 2026
Merged

johantor merged 2 commits into
mainfrom
docs/branch-naming

Conversation

@johantor

Copy link
Copy Markdown
Owner

CI checks only the marketplace catalog, which this PR does not change.


Generated by Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018V5Gdmkz3pmXFQmygUYKVa
Copilot AI balanced review requested due to automatic review settings October 24, 2026 06:14

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approved

The documentation-only change is low risk, with only a non-blocking example inconsistency remaining.

1 open issue
What changed in this PR

This PR adds branch-naming guidance to the README’s Maintaining section, where this repository keeps contributor instructions.

Changes:

  • Defines <type>/<issue>-<slug> using a Conventional Commits type and a three-to-five-word slug.
  • Explains how to omit the issue number and asks contributors to rename generated branches before pushing.
File Description
README.md Documents the branch-naming convention and examples.

Review effort: Balanced

Comment thread README.md Resolved
@johantor
johantor merged commit a87b53a into main Oct 24, 2026
1 check passed
@johantor
johantor deleted the docs/branch-naming branch October 24, 2026 06:32
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.

3 participants