Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johantor merged 2 commits into from
Oct 24, 2026
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f59c9f
docs(readme): name branches <type>/<issue>-<slug>
claude Oct 24, 2026
fdbc5b5
docs(readme): give the no-issue branch example a three-word slug
claude Oct 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ The site is `docs/`, served by GitHub Pages from `main`. `docs/style.css` is a c
site's stylesheet (`johantor/crew`, `docs/style.css`), so keep the two in step; marketplace-only
styles live in `docs/plugins.css`.

Name a branch for what it changes: `<type>/<issue>-<slug>`, with the Conventional Commits type
and a slug of three to five words, such as `fix/12-board-description-mismatch`. With no issue,
drop `<issue>-`: `docs/readme-branch-naming`. A generated name such as `claude/vigilant-keller-vvje0k`
says nothing in the branch list; rename it before you push. crew and board use the same rule.

## License

[Apache-2.0](LICENSE). The plugins collect no data and send nothing to the maintainers. An
Expand Down
Loading