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.

Sign up for GitHub

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

Make contributors aware of the pydocstyle requirements. #3805

Merged
merged 1 commit into from
Dec 20, 2024
Merged

Make contributors aware of the pydocstyle requirements. #3805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion CONTRIBUTING.rst
View file
Open in desktop
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
View file
Open in desktop
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
Loading