Move Contributing section

Signed-off-by: Cristian Le <git@lecris.dev>
This commit is contained in:
Cristian Le 2023-07-09 21:56:50 +02:00
parent fbbf5343f9
commit 25a5d09861
Failed to extract signature
3 changed files with 26 additions and 10 deletions

View File

@ -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
```
<!-- SHINX-END -->

15
docs/CONTRIBUTING.md Normal file
View File

@ -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
```

View File

@ -1,5 +1,16 @@
# Json-Schema-Validator
:::{toctree}
---
maxdepth: 2
titlesonly: true
caption: Contents
glob: true
hidden: true
---
CONTRIBUTING
:::
:::{include} ../README.md
---
start-after: <!-- SHINX-START -->