Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Co-authored-by: Taylor Salo <tsalo90@gmail.com>
  • Loading branch information
eurunuela and tsalo authored Sep 11, 2023
1 parent f7c10eb commit b225bc4
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,9 +290,10 @@ Docstrings should follow [numpydoc][link_numpydoc] convention.
We encourage extensive documentation.

The Python code itself should follow [PEP8][link_pep8] convention, with at most about 500 lines of
code (not including docstrings) per script. We use [black][link_black] and [isort][link_isort] to
enforce this code style, and we strongly recommend running both tools on your fork before opening a
pull request. We use [pre-commit][link_precommit] to automatically fix style issues when commit is
code (not including docstrings) per script.
We use [black][link_black] and [isort][link_isort] to enforce this code style,
and we strongly recommend running both tools on your fork before opening a pull request.
We use [pre-commit][link_precommit] to automatically fix style issues when commit is
pushed rather than making contributors try to figure out why a contribution is out of compliance
with the style guides.

Expand Down

0 comments on commit b225bc4

Please sign in to comment.