Move Contributing section
Signed-off-by: Cristian Le <git@lecris.dev>
This commit is contained in:
parent
fbbf5343f9
commit
25a5d09861
10
README.md
10
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`).
|
> 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 -->
|
<!-- SHINX-END -->
|
||||||
|
|||||||
15
docs/CONTRIBUTING.md
Normal file
15
docs/CONTRIBUTING.md
Normal 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
|
||||||
|
```
|
||||||
@ -1,5 +1,16 @@
|
|||||||
# Json-Schema-Validator
|
# Json-Schema-Validator
|
||||||
|
|
||||||
|
:::{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 2
|
||||||
|
titlesonly: true
|
||||||
|
caption: Contents
|
||||||
|
glob: true
|
||||||
|
hidden: true
|
||||||
|
---
|
||||||
|
CONTRIBUTING
|
||||||
|
:::
|
||||||
|
|
||||||
:::{include} ../README.md
|
:::{include} ../README.md
|
||||||
---
|
---
|
||||||
start-after: <!-- SHINX-START -->
|
start-after: <!-- SHINX-START -->
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user