Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.54 KB
Raw

How to contribute

Bugs and suggestions

Use the in the issues tab to report bugs, give suggestions and rise discussions.

Projects

The developing route of Tree-of-Life is registered and organized in the Projects tab. Browse it freely to see to where the project is heading and if you wish to conbribute to a given topic, just let us now by raising an issue.

Code Style

Style your code following PEP8 rules, some necessary exceptions are allowed for the Tree-of-Life project. The following flake8 options enforce the coding style: flake8 --hang-closing --ignore=W293,W503,E402. Please follow these rules when submitting Pull Requests.

W293 blank line contains whitespaces
W503 line break before binary operator, actually favoured by PEP8
E402 module level import not at top of file, in Tree-of-Life sometimes is necessary to import later on
-hang-closing, allows:
my_func(
    var1,
    var2,
    )

Pull Request

  • Always submit a Pull Request from a cloned or forked repository.
  • Pull Requests title should start with a proposal of version change and, if helpful, followed by a short title: v1.3.12 - corrected bug in updater
    • follow versioning standards: [major/visible [ new feature [ bug correction]]
    • new version number should be updated in the README.md file.
  • Pull Request description should state the added improvements and corrections.
  • Pull Request should close issues whenever applicable.

Thanks!