Skip to content

Commit 8ff9dd9

Browse files
committedApr 25, 2024
Add interrogation instructions
1 parent 2e0afe9 commit 8ff9dd9

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed
 

‎CONTRIBUTING.rst

+5-3
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ When making changes, please follow these guidelines:
2828
- Document your changes in the code and update the README file if necessary.
2929
- After making changes, please validate your changes.
3030

31-
1. Run static type checking: ``mypy cardroom``
32-
2. Run style checking: ``flake8 cardroom``
33-
3. Run unit tests: ``DJANGO_SETTINGS_MODULE=settings python -m cardroom test``
31+
1. Run style checking: ``flake8 cardroom``
32+
2. Run static type checking: ``mypy cardroom``
33+
3. Run checks for missing docstrings: ``interrogate -f 100 -i -m -n -p -s -r '^\w+TestCase' cardroom``
34+
4. Run unit tests: ``DJANGO_SETTINGS_MODULE=settings python -m cardroom test``
35+
5. Run doctests: ``python -m doctest cardroom/*.py``
3436

3537
Submitting a Pull Request
3638
-------------------------

‎requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ djangorestframework~=3.14.0
66
djangorestframework-stubs[compatible-mypy]~=3.14.5
77
django-stubs[compatible-mypy]~=4.2.7
88
flake8~=6.1.0
9+
interrogate~=1.7.0
910
mypy~=1.7.1
1011
pokerkit~=0.4.17
1112
Sphinx~=7.2.6

0 commit comments

Comments
 (0)
Please sign in to comment.