Contributing¶
This project is intended to be a community effort, and everyone is welcome to contribute.
The ways of contributing can be broadly divided into two categories:
- Reporting a bug
- Requesting a new feature
Reporting a bug¶
If you have found a bug in any of protlearn’s modules, please create an issue on Github.
We kindly ask you to provide the following information:
- Describe the bug
- Provide code/steps to reproduce the bug
- Describe the behavior you expected from the module
- State the Python and protlearn versions used
- Provide screenshots of the output (optional)
- Add additional context (optional)
Requesting a new feature¶
The amount of features extractable from amino acid sequences has been steadily increasing over the past years and decades. If you come across a feature that you would like to see included in protlearn, please submit an issue on Github.
If you do so, please provide the following information:
- State the module for which you would like to request a new feature
- Describe the solution that you envision
- Describe alternatives you may have considered (optional)
- Additional context (optional)