Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/update contributing guide #911

Merged
merged 1 commit into from
Jul 28, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ You can now clone your fork of scVelo and install the development mode
git clone https://github.com/YOUR-USER-NAME/scvelo.git
cd scvelo
git checkout --track origin/develop


Unix Systems
^^^^^^^^^^^^

The installation can be completed with

.. code:: bash

pip install -e '.[dev]'

The last line can, alternatively, be replaced by
Expand All @@ -31,16 +40,26 @@ The last line can, alternatively, be replaced by
pip install -r requirements-dev.txt


Finally, to make sure your code follows our code style guideline, install pre-commit:
Windows
^^^^^^^

If running Windows, `hsnwlib` needs to be installed via `conda` and the installation with pip slightly adjusted:

.. code:: bash

pre-commit install
conda install -c conda-forge hnswlib
pip install -e .[dev]


Coding style
^^^^^^^^^^^^

Finally, to make sure your code follows our code style guideline, install pre-commit:

.. code:: bash

pre-commit install

Our code follows `black` and `flake8` coding style. Code formatting (`black`, `isort`) is automated through pre-commit hooks. In addition, we require that

- functions are fully type-annotated.
Expand Down