Skip to content

Commit 87ff557

Browse files
committed
Add note about how the checks are non-invasive.
1 parent 14b700a commit 87ff557

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

index.md

+2
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,8 @@ A pytest.ini is included to define common options around running tests. In parti
146146
- run doctests on modules and invoke Ruff tests
147147
- filters out known warnings caused by libraries/functionality included by the skeleton
148148

149+
These checks are non-invasive; they don't automatically modify the code, but merely report on violations. Correct the violations manually or consider running the relevant tools (e.g. `ruff format .` or `ruff check --fix .`). A pre-commit config exists, but due to [maintenance challenges](https://github.com/jaraco/skeleton/issues/109#issuecomment-1932575587) is unsupported (use at your own risk).
150+
149151
## Continuous Integration
150152

151153
The project is pre-configured to run Continuous Integration tests.

0 commit comments

Comments
 (0)