Skip to content

Commit cb30d17

Browse files
Merge pull request #525 from zerone0x/fix/docs-branch-naming-474
Docs correct — branch names use slash prefixes, not conventional-commit format in parentheses.
2 parents fb35e23 + c253c01 commit cb30d17

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -109,23 +109,21 @@ For the step-by-step checklist (create filter, register rewrite pattern, registe
109109

110110
## Branch Naming Convention
111111

112-
Every branch **must** follow one of these prefixes to identify the level of change:
112+
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.
113113

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

120-
The **scope** in parentheses indicates which part of the project is concerned (e.g. `git`, `kubectl`, `filter`, `tracking`, `config`).
121-
122-
**Branch title must clearly describe what is affected and the goal.**
120+
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>`.
123121

124122
Examples:
125123
```
126-
fix(git): log-filter-drops-merge-commits
127-
feat(kubectl): add-pod-list-filter
128-
chore(proxy): remove-deprecated-flags
124+
fix/git-log-filter-drops-merge-commits
125+
feat/kubectl-add-pod-list-filter
126+
chore/release-pipeline-cleanup
129127
```
130128

131129
---
@@ -149,7 +147,7 @@ chore(proxy): remove-deprecated-flags
149147
```bash
150148
git checkout develop
151149
git pull origin develop
152-
git checkout -b "feat(scope): your-clear-description"
150+
git checkout -b feat/scope-your-clear-description
153151
```
154152

155153
### 2. Make Your Changes

0 commit comments

Comments
 (0)