From 25a5d09861c9102a88c6fcd3ae846a718feeef3c Mon Sep 17 00:00:00 2001 From: Cristian Le Date: Sun, 9 Jul 2023 21:56:50 +0200 Subject: [PATCH] Move Contributing section Signed-off-by: Cristian Le --- README.md | 10 ---------- docs/CONTRIBUTING.md | 15 +++++++++++++++ docs/index.md | 11 +++++++++++ 3 files changed, 26 insertions(+), 10 deletions(-) create mode 100644 docs/CONTRIBUTING.md diff --git a/README.md b/README.md index d418536..3383cce 100644 --- a/README.md +++ b/README.md @@ -355,14 +355,4 @@ The example above will output the specified default values `{"height":10,"width" > Note that the default value specified in a `$ref` may be overridden by the current instance location. Also note that this behavior will break draft-7, but it is compliant to newer drafts (e.g. `2019-09` or `2020-12`). -## Contributing - -This project uses [`pre-commit`](https://pre-commit.com/) to enforce style-checks. Please install and run it before -creating commits and making pull requests. - -```console -$ pip install pre-commit -$ pre-commit install -``` - diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..e14b622 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing Guidelines + +Pull request are more than welcome on the +[GitHub page](https://github.com/pboettch/json-schema-validator). + +## Development environment + +This project uses [`pre-commit`](https://pre-commit.com/) to enforce style-checks. +These checks are enforced in the GitHub Actions, but it is encouraged to install +a development environment locally as well. + +```console +$ pip install -e .[dev] +$ pre-commit install +``` diff --git a/docs/index.md b/docs/index.md index 2bd6894..2c06ce8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,16 @@ # Json-Schema-Validator +:::{toctree} +--- +maxdepth: 2 +titlesonly: true +caption: Contents +glob: true +hidden: true +--- +CONTRIBUTING +::: + :::{include} ../README.md --- start-after: