Skip to content

Commit 99dbd40

Browse files
committed
docs: Change documentation to reflect pre-commit usage
1 parent cb53008 commit 99dbd40

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@ To run these automatically when committing files (runs only on the staged files)
9191

9292
To avoid running these checks when committing, use `git commit --no-verify`.
9393

94-
You can also run the `./scripts/test` script to check for linting, spelling, and run unit tests.
94+
You can also run the `./scripts/test` script to run unit tests.
9595

9696
### Continuous Integration
9797

98-
CI will run the `scripts/test` script to check for code quality. If you have a Pull Request that fails CI, make sure to fix any linting, spelling or test issues reported by `scripts/test`.
98+
CI will run `pre-commit run --all-files` and `./scripts/test` to check for code quality. If you have a Pull Request that fails CI, make sure to fix any linting, spelling or test issues reported by either of these.
9999

100100
### Documentation
101101

docs/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ To run all of these:
5959
6060
> pre-commit run --all-files
6161
62-
You can also run the ``./scripts/test`` script to run all of the above and unit tests.
62+
You can also run ``./scripts/test`` to run the tests.
6363

6464
CHANGELOG
6565
^^^^^^^^^

0 commit comments

Comments
 (0)