You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-11Lines changed: 9 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -109,23 +109,21 @@ For the step-by-step checklist (create filter, register rewrite pattern, registe
109
109
110
110
## Branch Naming Convention
111
111
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.
113
113
114
114
| Prefix | Semver Impact | When to Use |
115
115
|--------|---------------|-------------|
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 |
119
119
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>`.
0 commit comments