Skip to content

Contributing

Thank you for your time to contribute to this project! Below we present some guidelines.

Reporting a bug

If you find a bug, please submit a new issue.

To be able to reproduce a bug, we will usually need the following information:

  • Versions of Python packages used (in particular version of this library).
  • A minimal code snippet allowing us to reproduce the bug.
  • What is the desired behaviour in the reported case?
  • What is the actual behaviour?

Submitting a pull request

Do:

  • Do use Google Style Guide. We use black for code formatting.
  • Do write unit tests. We use pytest.
  • Do write docstrings. We use Material for Mkdocs to generate the documentation.
  • Do write high-level documentation as examples and tutorials, illustrating introduced features.
  • Do consider submitting a draft pull request with a description of proposed changes.
  • Do check the Development section.

Don't:

  • Don't include license information. This project uses the MIT license. By submitting your pull request you implicitly and irrevocably agree to using this license.
  • Don't implement too many ideas in a single pull request. Multiple features should be implemented in separate pull requests.

Development

Installation & dependencies

To install the repository together with the dependencies run: 

$ git clone git@github.com:cbg-ethz/bmi.git  # Clone the repository
$ poetry add install -G dev                  # Install the dependencies
$ poetry run pre-commit install              # Install pre-commit hooks
$ poetry run pytest                          # Check if unit tests are passing

Building documentation locally

You can build the documentation on your machine using: 

$ poetry run mkdocs serve
and opening the generated link using web browser.