Skip to content

Commit

Permalink
Update contributing for single .flake8 file
Browse files Browse the repository at this point in the history
See PR #2074 and issues #493 / #2014
  • Loading branch information
peterjc committed May 24, 2019
1 parent 310da8a commit b051a3a
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions CONTRIBUTING.rst
Expand Up @@ -53,24 +53,19 @@ Unless you are using Python 2.7, please also install the bugbear plugin:

You can then run ``flake8`` directly as follows::

$ flake8 Bio/
$ flake8 BioSQL/
$ flake8 Tests/
$ flake8 Scripts/
$ flake8 Doc/examples/

Each of these folders has its own flake8 settings file, but in the long term
we would like all the code to follow the same strict settings.
$ flake8

You can run the reStructuredText checks with the ``restructuredtext-lint``
tool (also known as ``rst-lint``)::

$ pip install restructuredtext_lint
$ rst-lint --level warning *.rst

More simply, we currently suggest you install the git pre-commit hook described
here which will check our basic coding conventions as you work:
https://github.com/biopython/biopython/issues/493
More simply, we currently suggest you install the flake8 git pre-commit hook
which will check our basic coding conventions as you work::

$ flake8 --install-hook git
$ git config --bool flake8.strict true


Testing
Expand Down

0 comments on commit b051a3a

Please sign in to comment.