Skip to content

Contributing

Contributions are welcome, but first please read the guidelines shown below:

  • Contributions may get rejected, if they do not fit the project
  • Try to create performant code (both memory and cpu)
  • Don't add any new requirements
  • It must build into a docker image
  • Follow pep8 with a max line length of 100
  • Create DRY code
  • Where possible create unit tests for new code
  • The docs must be easily readable
  • Don't use GitHub's issues for reporting vulnerabilities
  • Make commit messages useful, commits with names like "Updated x.py" will be rejected
  • Test your code before submitting to pull request
  • Contributions must be licensed under the same as the project
  • Submit pull requests to 'next' branch
  • Don't change the version number
  • Must be compatible with the target Python version
  • Do not use deprecated features