Skip to content

Align branch naming guidelines with GitHub issue based branch defaults #27

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
lex57ukr merged 2 commits into from
Jan 17, 2026
Merged

Align branch naming guidelines with GitHub issue based branch defaults #27

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6090fca
Update branch naming guidelines to align with GitHub's default format
lex57ukr Jan 17, 2026
86637d6
Clarify branch creation instructions for collaborators and external c…
lex57ukr Jan 17, 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
7 changes: 5 additions & 2 deletions docs/how-to/how-to-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,14 @@ Issues act as lightweight tickets and historical context.
### 2. Working on an Issue

- Create a branch for the work
- **Collaborators**: Use GitHub's **Create a branch** link on the issue page
- **External contributors**: Create a branch in your fork following the same naming pattern
- Implement the change
- Commit freely during development

Prefer the `issue-NN-short-description` naming convention (e.g., `issue-42-fix-login-bug`).
This is not enforced but aids traceability.
GitHub generates branch names in the format `<issue-number>-<issue-title-slug>`
(e.g., `42-fix-login-bug`). Following this pattern ensures consistency whether the branch
is created automatically or manually.

### 3. Opening a Pull Request

Expand Down