Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

72 lines (45 loc) · 1.64 KB
Raw

Contributing to Pycrostates

Once the contribution discussed, you can propose a change by creating a new pull request. Pycrostates tries to adhere as much as possible to the conventions used by MNE-python, so we recommend reading the MNE-python contribution guide for more details about this process.

  • Fork the Pycrostates Repository on Github.

  • Clone your forked repository locally.

  • [OPTIONAL] create a new branch on which you will add your changes.

  • [OPTIONAL] create a new environment, for example with Anaconda:

    conda create -n pycrostates_dev python=3.9

    then activate your environment:

    conda activate -n pycrostates_dev

  • Navigate to the repository's root folder

  • Install pycrostates in editable mode with all optional dependencies:

    pip install -e .[all]

  • Make your changes.

  • Open a pull request

Code style

Pycrostates uses flake, black and isort to enforce code style.

You can run these tools from the pycrostates root directory using the corresponding command:

  • flake8

    flake8 pycrostates

  • black

    black pycrostates

  • isort

    isort pycrostates

Running the test suite

pytest pycrostates

Building the documentation

From within the /docs directory:

make html