sandpit is an internal development and testing repo not intended for public consumption, but if you fancy making a contribution, knock yourself out.
- This is open source software. We endeavour to make the code as transparent as possible.
- We use Visual Studio Code for development and testing, but you are at liberty to use your preferred IDE.
- We document the code in accordance with Sphinx docstring conventions.
- We use pylint (>=2.6.0) for code analysis.
- We use bandit (>=1.7) for security vulnerability analysis.
- We use black (>= 20.8) for code formatting and ask that you do the same.
We use python's native pytest framework for local unit testing, complemented by the GitHub Actions automated build and testing workflow.
Please write pytest examples for new code you create and add them to the /tests folder following the naming convention test_*.py.
Please send a GitHub Pull Request to sandpit with a clear list of what you've done (read more about pull requests). Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
Thanks,
semuadmin