Skip to content

Commit

Permalink
Update checks to include tests
Browse files Browse the repository at this point in the history
  • Loading branch information
AussieSeaweed committed Jan 23, 2025
1 parent 2a38052 commit 4d6bbb2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ jobs:
python-version: '3.11'
- run: pip install -r requirements.txt
- name: Run style checking
run: flake8 battlib
run: flake8 battlib tests
- name: Run static type checking
run: mypy --strict battlib
run: mypy --strict battlib tests
- name: Run unit tests
run: python -m unittest
- name: Run doctests
run: python -m doctest battlib/*.py
run: python -m doctest battlib/*.py
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ When making changes, please follow these guidelines:
if necessary.
- After making changes, please validate your changes.

1. Run style checking: ``flake8 battlib``
2. Run static type checking with ``--strict`` flag: ``mypy --strict battlib``
1. Run style checking: ``flake8 battlib tests``
2. Run static type checking with ``--strict`` flag: ``mypy --strict battlib tests``
3. Run checks for missing docstrings: ``interrogate -f 100 -i -m -n -p -s -r '^\w+TestCase' battlib``
4. Run unit tests: ``python -m unittest``
5. Run doctests: ``python -m doctest battlib/*.py``
Expand Down

0 comments on commit 4d6bbb2

Please sign in to comment.