Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 1.35 KB

Contributing to MESS

We are interested in hearing any and all feedback so feel free to raise any questions, bugs encountered, or enhancement requests as Issues.

Setting up a development environment

The following assumes that you have already set up an install of conda and that the conda command is available on your system path. Refer to your preferred conda installer:

  1. Create a new conda environment with the minimum python version required:

    conda create -n mess python=3.11

  2. Install all required packages for developing MESS:

    pip install -e .[dev]

  3. Install the pre-commit hooks

    pre-commit install

  4. Create a feature branch, make changes, and when you commit them the pre-commit hooks will run.

    git checkout -b feature
...
git push --set-upstream origin feature

    The last command will print a link that you can follow to open a PR.

Testing

Run all the tests using pytest

pytest

Building Documentation

From the project root, you can build the documentation with:

jupyter-book build docs