Skip to content

Commit 2efa525

Browse files
committed
docs: Add branch selection guidance to CONTRIBUTING.md
1 parent b8fd814 commit 2efa525

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

Diff for: CONTRIBUTING.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,32 @@ uv sync --frozen --all-extras --dev
1515

1616
## Development Workflow
1717

18-
1. Create a new branch for your changes
19-
2. Make your changes
20-
3. Ensure tests pass:
18+
1. Choose the correct branch for your changes:
19+
- For bug fixes to a released version: use the latest release branch (e.g. v1.1.x for 1.1.3)
20+
- For new features: use the main branch (which will become the next minor/major version)
21+
- If unsure, ask in an issue first
22+
23+
2. Create a new branch from your chosen base branch
24+
25+
3. Make your changes
26+
27+
4. Ensure tests pass:
2128
```bash
2229
uv run pytest
2330
```
24-
4. Run type checking:
31+
32+
5. Run type checking:
2533
```bash
2634
uv run pyright
2735
```
28-
5. Run linting:
36+
37+
6. Run linting:
2938
```bash
3039
uv run ruff check .
3140
uv run ruff format .
3241
```
33-
6. Submit a pull request
42+
43+
7. Submit a pull request to the same branch you branched from
3444

3545
## Code Style
3646

0 commit comments

Comments
 (0)