๐ค Contributing to SciPyMasterPro¶
Thanks for your interest! SciPyMasterPro is a modular learning project for mastering SciPy for statistics, optimisation, linear algebra and simulation through reusable utilities, synthetic datasets, an interactive app and notebooks. Contributions that improve functionality, correctness, documentation or educational clarity are all welcome.
๐ Ways to contribute¶
- ๐ Utilities โ new functions in
utils/, with docstrings and tests. - ๐งช Notebooks โ new or improved demonstrations (they must execute cleanly:
make test-notebooks). - ๐จ App pages โ Streamlit pages in
streamlit_app/pages/(they are smoke-tested:make test-app). - ๐ Docs โ tutorials and guides in
docs/; code samples there are executed by the test suite. - ๐ Bug reports and fixes โ open an issue with a minimal reproduction, or a PR with a regression test.
๐ Development setup¶
git clone https://github.com/<you>/ScipyMasterPro.git
cd ScipyMasterPro
python -m venv .venv && source .venv/bin/activate # or: uv venv && source .venv/bin/activate
pip install -e ".[dev,docs]" # or: uv pip install -e ".[dev,docs]"
pre-commit install
scipymasterpro info # sanity check
Useful targets (make help lists them all):
| Command | Purpose |
|---|---|
make format |
ruff --fix, black, isort |
make lint |
the blocking CI checks |
make test |
unit + property + plot tests |
make test-app |
Streamlit page smoke tests |
make test-notebooks |
execute all notebooks |
make docs-serve |
live documentation preview |
make freeze-deps |
regenerate requirements_dev.txt after changing pyproject.toml |
โ Guidelines¶
- Branch from
main:git checkout -b feat/short-description. - Style: black (line length 100), isort, ruff.
make formatbefore committing. - Docstrings: NumPy style on every public function; they feed the API reference.
- Tests: add or update tests for behaviour you change. Prefer a Hypothesis property test when the behaviour is an invariant.
- Determinism: functions that draw random numbers take a
seedargument. - Dependencies: add them to
pyproject.toml, then runmake freeze-deps. - Changelog: add a line under
## [Unreleased]indocs/CHANGELOG.md. - Commits: focused, descriptive messages (
fix:,feat:,docs:,ci:prefixes are used).
๐ Pull requests¶
- Run
make lint test test-applocally; CI runs the same plus notebooks, build and docs. - Open the PR against
mainand fill in the template (what, why, how it was tested). - Include screenshots for UI or plot changes.
- The
All checks passedjob must be green before merge.
๐ฆ Releases (maintainers)¶
Bump version in pyproject.toml, move the [Unreleased] notes into a new section in
docs/CHANGELOG.md, merge, then tag vX.Y.Z and push the tag. The release workflow builds the
package, creates the GitHub Release and (when enabled) publishes to PyPI.
๐ Code of conduct¶
This project follows the Code of Conduct. Be kind, constructive and credit others where due.
๐ก Unsure whether an idea fits? Open an issue first and we will figure it out together.