Skip to content

Contributing

ppsds is a research package, so the contribution that matters most is the one that keeps a number stable. Everything else is ordinary open-source work. There are four ways in, and they match the bottom row of Get started.

If you… Start here
Played the game and found something wrong Report a problem
Built a simulation, or used a system you already have, and want to give the work back Open an issue or send a pull request
Want to compare methods at scale Send a benchmark as a pull request
Work in a domain this library does not cover yet, or want to research it Talk about a collaboration

The short version of the one rule: a change that touches numerics must survive an A/B comparison, and the acceptance line is bit-identical. Pull requests has the commands and the reasoning.

The repository's CONTRIBUTING.md is the same material in one file, for someone already in the checkout.

Next