👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to re-com which is hosted on Github. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
Check if the issue has already been reported. If possible provide:
- Version of re-com being used
- Minimal reproduction steps
Use your best judgement on what is needed here.
Create pull requests to the develop branch, work will merged onto master when it is ready to be released.
If possible provide:
- Code that fixes the bug
- Failing tests which pass with the new changes
- Improvements to documentation to make it less likely that others will run into issues (if relevant).
If possible provide:
- Code that implements the new feature
- Tests to cover the new feature including all of the code paths
- Docstrings for functions
- Documentation examples