aljaz/mcp-python-sdk
1
0
Fork 0
mirror of https://github.com/aljazceru/mcp-python-sdk.git synced 2025-12-18 14:34:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add branch selection guidance to CONTRIBUTING.md

Browse Source
This commit is contained in:
David Soria Parra
2025-01-03 21:27:21 +00:00
parent b8fd814f1c
commit 2efa525a66
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@@ -15,22 +15,32 @@ uv sync --frozen --all-extras --dev
## Development Workflow ## Development Workflow
1. Create a new branch for your changes 1. Choose the correct branch for your changes:
2. Make your changes - For bug fixes to a released version: use the latest release branch (e.g. v1.1.x for 1.1.3)
3. Ensure tests pass: - 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 ```bash
uv run pytest uv run pytest
``` ```
4. Run type checking:
5. Run type checking:
```bash ```bash
uv run pyright uv run pyright
``` ```
5. Run linting:
6. Run linting:
```bash ```bash
uv run ruff check . uv run ruff check .
uv run ruff format . uv run ruff format .
``` ```
6. Submit a pull request
7. Submit a pull request to the same branch you branched from
## Code Style ## Code Style