Improve developer tooling #50
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds some tools to help with writing consistent, well-formatted schemas with fewer spelling errors.
The presence of
.pre-commit-config.yaml
does not activate the tools so everyone can decide if they want to use them. To enabled the checks, install pre-commit withpipx install pre-commit
and then activate it in the project by runningpre-commit install
at the root of the project. Once installed pre-commit will run the checks on every commit and reject the commit if errors are found; it will try to auto-correct several types of errors. It is also possible to run the checks manually withpre-commit run -a
.The checks in pre-commit are not run as gh-actions in the created project. This may be added later (as an option).