Interested in contributing to check-jsonschema? That's great!
…should be reported the Issue Tracker_
If you want to help work on the code, here are a few tips for getting setup.
Testing is done with tox. To run the tests, just run
tox
and a full test run will execute.
check-jsonschema lints with pre-commit.
To setup the pre-commit integration, first ensure you have it installed
pipx install pre-commit
Then setup the hooks:
pre-commit install
There are example files for the various pre-commit hooks defined in
tests/example-files/.
The positive/ test cases should pass the hook with the matching name, and
the negative/ test cases should fail the hook with the matching name.
These files are automatically picked up by the testsuite and checked.
Hooks are defined in src/check_jsonschema/catalog.py, and rendered to
.pre-commit-hooks.yaml with the generator script. It can be run with
make generate-hooks
Schemas are pulled down based on this same config. If you want to update the vendored schema copies, run
make vendor-schemas
All of the features of check-jsonschema should be documented in the readme
and changelog. If you notice missing documentation, that's a bug!