Contributing
We love your input! We want to make contributing to Python Release Master as easy and transparent as possible.
Development Setup
Fork the repository
Clone your fork:
git clone https://github.com/yourusername/python-release-master.git cd python-release-master
Create a virtual environment:
python -m venv venv source venv/bin/activate # Linux/macOS # or venv\Scripts\activate # Windows
Install development dependencies:
pip install -e ".[dev]"
Running Tests
Run the test suite:
python -m pytest
With coverage:
python -m pytest --cov=python_release_master
Building Documentation
Build the documentation locally:
cd docs
make html
Pull Request Process
Update the documentation if needed
Update the tests if needed
Run the test suite
Create a Pull Request with a clear title and description
Wait for review and address any comments
Code Style
We use:
Black for code formatting
isort for import sorting
flake8 for linting
mypy for type checking
Run all checks:
black .
isort .
flake8 .
mypy .