Skip to content

Commit

Permalink
Add pylint to pre-commit (#141)
Browse files Browse the repository at this point in the history
* Add pylint to dev_requirements.txt

* Add pylint to pre-commit-config.yaml

* Add pylint to contributing docs
  • Loading branch information
SauravMaheshkar authored Dec 20, 2021
1 parent fc2852a commit f899f3a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,10 @@ repos:
language: python
language_version: python3
types: [python]
- id: pylint
name: pylint
entry: pylint
language: python
language_version: python3
types: [python]
args: ['--disable=all', '--enable=missing-docstring']
1 change: 1 addition & 0 deletions dev_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
pylint
pytest
pytest-runner
pre-commit
Expand Down
3 changes: 1 addition & 2 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ Installing a Development Version
pip install -e . # Installs SCICO from the current directory in editable mode


9. The SCICO project uses the `Black <https://black.readthedocs.io/en/stable/>`_
and `isort <https://pypi.org/project/isort/>`_ code formatting utilities.
9. The SCICO project uses the `Black <https://black.readthedocs.io/en/stable/>`_, `isort <https://pypi.org/project/isort/>`_ and `pylint <https://pylint.pycqa.org/en/latest/>`_ code formatting utilities.
You should set up a `pre-commit hook <https://pre-commit.com>`_ to ensure
any modified code passes format check before it is committed to the development repo:

Expand Down

0 comments on commit f899f3a

Please sign in to comment.