Contributing

We welcome any contributions, enhancements, and bug-fixes. Open an issue on Github and submit a pull request.

Code approval/review guidelines

In case you finished the work on your branch, create a pull request, describe (optionally) your changes in the pull request and set at least one of the authors mentioned above as code reviewer. The closed branch should be deleted after merge.

Before approving a pull request, check for and discuss:

  • Repetitive (copy & paste) code -> Could this be refactored/moved to a function?

  • Stale / commented out functional code -> Could these artifacts be deleted?

  • Duplication of existing functionality -> Could existing code already solve the adressed problem?

  • Unused imports -> Could these imports be cleaned up?`

  • File locations don’t mirror their logical connection to a feature -> Could they be grouped within a logical unit (e.g. folder)?

  • Outdated / needlessly complex python functionality -> Could this be solved by more modern python language features (e.g. itertools)?

  • Is there a test for your functionality? -> add new test or modify an existing test.