Skip to content

docs: correct branch naming example (#474) #525

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
FlorianBruniaux merged 2 commits into from
Mar 28, 2026
+9 −11
Merged

docs: correct branch naming example (#474) #525

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5e1d7f
docs: correct branch naming guidance (#474)
zerone0x Mar 12, 2026
c253c01
docs: correct branch naming example (#474)
zerone0x Mar 12, 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
20 changes: 9 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,21 @@

## Branch Naming Convention

Every branch **must** follow one of these prefixes to identify the level of change:
Git branch names cannot include spaces or colons, so we use slash-prefixed names. Pick the prefix that matches your change type and follow it with an optional scope and a short, kebab-case description.

| Prefix | Semver Impact | When to Use |
|--------|---------------|-------------|
| `fix(scope): ...` | Patch | Bug fixes, corrections, minor adjustments |
| `feat(scope): ...` | Minor | New features, new filters, new command support |
| `chore(scope): ...` | Major | Breaking changes, API changes, removed functionality |
| `fix/` | Patch | Bug fixes, corrections, minor adjustments |
| `feat/` | Minor | New features, new filters, new command support |
| `chore/` | Major | Breaking changes, API changes, removed functionality |

The **scope** in parentheses indicates which part of the project is concerned (e.g. `git`, `kubectl`, `filter`, `tracking`, `config`).

**Branch title must clearly describe what is affected and the goal.**
Combine the prefix with a scope if it adds clarity (e.g. `git`, `kubectl`, `filter`, `tracking`, `config`) and finish with a descriptive slug: `fix/<scope>-<description>` or `feat/<description>`.

Examples:
```
fix(git): log-filter-drops-merge-commits
feat(kubectl): add-pod-list-filter
chore(proxy): remove-deprecated-flags
fix/git-log-filter-drops-merge-commits
feat/kubectl-add-pod-list-filter
chore/release-pipeline-cleanup
```

---
Expand All @@ -57,7 +55,7 @@ chore(proxy): remove-deprecated-flags
```bash
git checkout develop
git pull origin develop
git checkout -b "feat(scope): your-clear-description"
git checkout -b feat/scope-your-clear-description
```

### 2. Make Your Changes
Expand Down