If you are interested in contributing to open-retrievals,
- Feel free to send a Pull Request
- If you want to implement a new feature and unsure about it, you can post an issue first
Once you finish implementing a feature a bug-fix, please send a Pull Request to https://github.com/LongxingTan/open-retrievals
To develop tfts on your machine, here are some tips:
- Uninstall existing open-retrievals installations:
- Clone a copy of open-retrievals from source
- Create a new branch and edit the code
- Install pre-commit hooks
- Ensure your code is formatted correctly by testing against the styleguide of flake8
- Ensure the entire test suite passed and the code coverage roughly stays the same
- Update and test the documentation