Skip to content

Commit

Permalink
Make contributors aware of the pydocstyle requirements. (#3805)
Browse files Browse the repository at this point in the history
Make contributors aware of the new pydocstyle test.
  • Loading branch information
aknrdureegaesr authored Dec 20, 2024
1 parent b458842 commit dde4e3e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ Here are some guidelines about how you can contribute to Nikola:
* If you are fixing an issue, **include the issue number in commit** and/or pull
request text (eg. ``fix #1234``) so the issue `is automatically closed
<https://help.github.com/articles/closing-issues-via-commit-messages/>`_.
* Run ``flake8 nikola tests`` for **style consistency**.
* Run ``flake8 nikola tests`` and ``pydocstyle --count --match-dir='(?!^\\.)(?!data).*' nikola/``
for **style consistency**.
* Ensure your Git name and e-mail are set correctly (they will be public)
and `added to GitHub <https://github.com/settings/emails>`_
* **Try writing some tests** if possible — again, following existing tests is
Expand Down
1 change: 1 addition & 0 deletions requirements-tests.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ pytest-cov>=2.6.1
feedparser>=6.0.10
freezegun>=0.3.10
flake8>=3.7.7
pydocstyle>=6.3.0

0 comments on commit dde4e3e

Please sign in to comment.