Skip to content

Commit e48718c

Browse files
committed
docs: update CONTRIBUTING with v2 branching strategy
Clarify that main is now the v2 development branch where breaking changes are welcome, and v1.x is the maintenance branch for security and critical bug fixes only.
1 parent ef96a31 commit e48718c

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,14 @@ uv tool install pre-commit --with pre-commit-uv --force-reinstall
2323
## Development Workflow
2424

2525
1. Choose the correct branch for your changes:
26-
- For bug fixes to a released version: use the latest release branch (e.g. v1.1.x for 1.1.3)
27-
- For new features: use the main branch (which will become the next minor/major version)
28-
- If unsure, ask in an issue first
26+
27+
| Change Type | Target Branch | Example |
28+
|-------------|---------------|---------|
29+
| New features, breaking changes | `main` | New APIs, refactors |
30+
| Security fixes for v1 | `v1.x` | Critical patches |
31+
| Bug fixes for v1 | `v1.x` | Non-breaking fixes |
32+
33+
> **Note:** `main` is the v2 development branch. Breaking changes are welcome on `main`. The `v1.x` branch receives only security and critical bug fixes.
2934
3035
2. Create a new branch from your chosen base branch
3136

0 commit comments

Comments
 (0)