From 2efa525a664a02af7f7c5ac1f8599b75aa5605c1 Mon Sep 17 00:00:00 2001 From: David Soria Parra Date: Fri, 3 Jan 2025 21:27:21 +0000 Subject: [PATCH] docs: Add branch selection guidance to CONTRIBUTING.md --- CONTRIBUTING.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 02cf3879..929e5f50 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,22 +15,32 @@ uv sync --frozen --all-extras --dev ## Development Workflow -1. Create a new branch for your changes -2. Make your changes -3. Ensure tests pass: +1. Choose the correct branch for your changes: + - For bug fixes to a released version: use the latest release branch (e.g. v1.1.x for 1.1.3) + - For new features: use the main branch (which will become the next minor/major version) + - If unsure, ask in an issue first + +2. Create a new branch from your chosen base branch + +3. Make your changes + +4. Ensure tests pass: ```bash uv run pytest ``` -4. Run type checking: + +5. Run type checking: ```bash uv run pyright ``` -5. Run linting: + +6. Run linting: ```bash uv run ruff check . uv run ruff format . ``` -6. Submit a pull request + +7. Submit a pull request to the same branch you branched from ## Code Style