Contributing

PyStatsV1 welcomes contributions from students, instructors, and practitioners.

Quick path

  1. Read the CONTRIBUTING.md file in the repository root.

  2. Browse issues labeled good first issue or help wanted.

  3. Fork the repository and clone your fork.

  4. Create and activate a virtual environment, then run:

    pip install -r requirements.txt
    make lint
    make test
    
  5. Make your change, ensure the checks still pass, and open a pull request.

Types of contributions

  • Documentation improvements and teaching notes

  • Small refactors and test improvements

  • New chapter examples (simulator + analyzer + Makefile targets)

  • Bug fixes and robustness improvements

For more details, including coding style and pull request guidelines, see CONTRIBUTING.md.