Contributions are welcome and will be fully credited. We accept contributions via Pull Requests on Github. Please review these guidelines before submitting any pull requests.
- Document any change in behaviour - Make sure the README and any other relevant documentation are kept up-to-date.
- Create feature branches - Make sure you create feature branches and update your rebase before submitting your pull request.
- One pull request per feature - If you want to do more than one thing, send multiple pull requests.
- Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
- Stick to pep8 python style guide for the backend and format your code using
blackandflake8. - Use Numpy docstrings style to document your code.
- Apply ESLint and prettier style guide rules for the frontend code. Format your frontend code using prettier
yarn run prettier. - Write tests for any new functions or methods you introduce. Make sure the tests pass before submitting your pull request. You can run the tests using
python -m unittest discoverand measure the code coverage usingcoverage run -m unittest discover && coverage report. - Write tests for any new components you introduce in the frontend. Make sure the tests pass before submitting your pull request. You can run the tests using
yarn run test. - Write meaningful commit messages. If you had to make multiple commits while developing, please squash them before submitting.