Contributing Guide
Thank you for your interest in contributing to pyetm! This guide will help you get started.
Ways to Contribute
- Report bugs: Open an issue on GitHub Issues
- Suggest features: Discuss ideas in GitHub Discussions
- Improve documentation: Submit documentation improvements
- Write code: Fix bugs or implement new features
Getting Started
See Development for setup instructions.
Code Style
pyetm follows these conventions:
- PEP 8 for Python code style
- Google-style docstrings for documentation
- Type hints for all functions and methods
- 100 characters maximum line length
Engineering principles
Alongside style, contributions should follow the ETM engineering principles:
- Contributability — avoid niche tech without a documented reason
- Simplicity & modularity — prefer simple, replaceable components and well-supported libraries over bespoke code
- Rigour — cover new code with unit and integration tests
- Traceability — code should record why, not just how
- Perceived speed — keep interactive workflows responsive
The full set, including engine-specific principles, is in the main ETM docs.
Pull Request Process
- Fork the repository
- Create a feature branch:
git checkout -b feature/my-feature - Make your changes
- Run tests:
poetry run pytest - Commit your changes
- Push and create a pull request
Testing
All new code must include tests:
# Run all tests
poetry run pytest
# Run specific test
poetry run pytest tests/models/test_scenario.py
# Run with coverage
poetry run pytest --cov=pyetm
Documentation
Update documentation for user-facing changes:
- Update docstrings using Google style
- Add examples to user guide if applicable
- Build docs locally:
poetry run mkdocs serve
Questions?
Ask in GitHub Discussions or open an issue.