First of all, we would like to thank you for considering contributing towards CogStack!
Please consider the below a guideline. Best judgment should be used in situations where the guidelines are not clear.
All contributors are expected to follow our Code of Conduct.
If you have questions regarding this project, you are better off expressing them in our discourse rather than creating an issue on github.
Most of the relevant links to background information are listed in our README.
There are many ways of contributing to the project
- Reporting issues
- Suggesting new features
- Contributing to code
The following subsections will go into a little more detail regarding each of the above.
Some things to remember when reporting an issue:
- Describe the issue clearly
- Provide the steps to reproduce the issue (if possible)
- Describe the behaviour you observed
- Describe the behaviour you expected
- Include all relevant information, including (but not limited to)
- Version of MedCAT used
- Versions of dependencies used
- Config file(s)
- Database(s) used
- Deployment environment
CogStack is always looking to grow and provide new features.
Some things to remember when suggesting a new feature:
- Describe the new feature in detail
- Describe the benefits of this new feature