CONTRIBUTING.md

Contributing to QAFS

Thank you for considering contributing to QAFS! You can contribute in so many ways like: code, answering questions, briging/implementing new use cases, examples and documentation.

Please keep in mind the following guidelines and practices when contributing:

1. Use make format to format the repository code. make format maps to a usage of black, and the repository adheres to whatever black uses as its strict pep8 format. No questions asked
2. Use make verify to lint, run tests, and typecheck on the project
3. Add unit tests for any new code you write
4. Add an example, or extend an existing example, with any new features you may add
5. Increment the version in the VERSION file. A CHANGELOG entry is expected along with version increases!