skills/rtk-ai__rtk
1
0
Fork 0
mirror of https://github.com/rtk-ai/rtk.git synced 2026-09-19 07:33:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #525 from zerone0x/fix/docs-branch-naming-474

Browse Source 
Docs correct — branch names use slash prefixes, not conventional-commit format in parentheses.
This commit is contained in:
Florian BRUNIAUX
2026-03-28 01:46:47 +01:00
committed by GitHub
parent fb35e23952 c253c0168b
commit cb30d174f7
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+9 -11
View File
@@ -109,23 +109,21 @@ For the step-by-step checklist (create filter, register rewrite pattern, registe
## 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
```
---
@@ -149,7 +147,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