Skip to content

Commit a46991e

Browse files
committed
Add notes to internal docs
- contrib doc should mention 'make vendor-schemas' for vendoring - add a releasing doc with the procedure written down
1 parent c009e7d commit a46991e

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,11 @@ Hooks are defined in `src/check_jsonschema/catalog.py`, and rendered to
4646

4747
make generate-hooks
4848

49+
Schemas are pulled down based on this same config. If you want to update the
50+
vendored schema copies, run
51+
52+
make vendor-schemas
53+
4954
## Documentation
5055

5156
All of the features of `check-jsonschema` should be documented in the readme

RELEASING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Releasing
2+
3+
- Bump the version with `./scripts/bump-version.py NEW_VERSION`
4+
- Add, commit with `git commit -m 'Bump version for release'`, and push
5+
- Publish the release with `make release`

0 commit comments

Comments
 (0)