When contributing to this repository, please first discuss the change you wish to make via issues, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct for this project, please follow it in all your interactions with the project.
When creating a bug or an issue please include as many details as possible. Create your issues here and follow this steps:
- Check previous closed issues , current open issues or our FAQ for a list of common questions or previously solved problems
- Use a clear and descriptive title for the issue to identify the problem.
- Provide all information about OS
- Provide information about the installation process (source, pip, conda, Docker, etc)
- software version including Python
- Detailed information on how to reproduce the problem
- Provide screenshots when useful
All kind of contributions are welcome, from fixing bugs, resolving issues or suggesting features. Look at the current issues to see how you can contribute and provide help.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
Please see our list of contributors, if you feel you have contributed to the project and we have neglected adding you to the list please accept our apologizes and let us know to correct it.