Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/AI_POLICY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# AI Usage Policy

This project is governed by the following policy regarding AI tool use.

Mutual respect and kindness are the principles that underpin this policy.

## No lying

We cannot and do not want to police what you do on your computer.

However, if you present generated work as though it were wholly your own, you
are attempting to deceive your reader.
Such behavior violates our "no lying" rule.

## No karma farming

If you have no interest in the project or its people, then you should not
"contribute" in order to burnish your online reputation.

## Use fewer words

Respect your reader's time.
Code and technical prose should be short and precise.

## Think for yourself

Only your own thoughts -- the human intelligence you apply to your work -- give
your contributions value and determine their suitability for the project.

## You own your work

You are responsible for your contributions and interactions.

As a result, Co-authored-by tags for LLMs are not permitted.

## Speak for yourself

Speaking to other humans should be done with limited machine assistance.

Translation and spell-checking are okay.

Grammatical and spelling misstakes are okay.
Your voice, including your errorz, matters and deserves to be preserved.

## Maintainer discretion

The project's maintainers will decide when and how this policy is enforced.
They reserve the right to do so based on their opinions regarding the best
interests of the project itself.

Protecting maintainers protects their projects.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Interested in contributing to `check-jsonschema`? That's great!

> [!IMPORTANT]
>
> If you use LLMs / generative AI, please read our [_AI Policy_][aipolicy].

## Questions, Feature Requests, Bug Reports, and Feedback...

…should be reported the [Issue Tracker](https://github.com/python-jsonschema/check-jsonschema/issues)_
Expand Down Expand Up @@ -55,3 +59,5 @@ vendored schema copies, run

All of the features of `check-jsonschema` should be documented in the readme
and changelog. If you notice missing documentation, that's a bug!

[aipolicy]: https://github.com/python-jsonschema/check-jsonschema/blob/main/.github/AI_POLICY.md
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[![pypi version](https://img.shields.io/pypi/v/check-jsonschema.svg)](https://pypi.org/project/check-jsonschema/)
[![supported pythons](https://img.shields.io/pypi/pyversions/check-jsonschema.svg)](https://pypi.org/project/check-jsonschema/)
[![pypi version](https://img.shields.io/pypi/v/check-jsonschema.svg)][pypi]
[![supported pythons](https://img.shields.io/pypi/pyversions/check-jsonschema.svg)][pypi]
[![build](https://github.com/python-jsonschema/check-jsonschema/actions/workflows/build.yaml/badge.svg)](https://github.com/python-jsonschema/check-jsonschema/actions/workflows/build.yaml)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/python-jsonschema/check-jsonschema/main.svg)](https://results.pre-commit.ci/latest/github/python-jsonschema/check-jsonschema/main)
[![readthedocs documentation](https://readthedocs.org/projects/check-jsonschema/badge/?version=stable&style=flat)](https://check-jsonschema.readthedocs.io/en/stable)
[![readthedocs documentation](https://readthedocs.org/projects/check-jsonschema/badge/?version=stable&style=flat)][docs]

[![check-jsonschema logo](https://github.com/python-jsonschema/check-jsonschema/raw/main/docs/_static/logo.png)](https://check-jsonschema.readthedocs.io/en/stable/)
[![check-jsonschema logo](https://github.com/python-jsonschema/check-jsonschema/raw/main/docs/_static/logo.png)][docs]

# check-jsonschema

Expand Down Expand Up @@ -44,6 +44,16 @@ Then run, as in

check-jsonschema --schemafile schema.json instance.json

## Documentation
## Project Information

Full documentation can be found at https://check-jsonschema.readthedocs.io/
- [Documentation][docs]
- [Changelog][changelog]
- [Contributing][contrib]
- [Source][repo]
- [PyPI][pypi]

[docs]: https://check-jsonschema.readthedocs.io/
[changelog]: https://check-jsonschema.readthedocs.io/en/stable/changelog.html
[contrib]: https://github.com/python-jsonschema/check-jsonschema/blob/main/.github/CONTRIBUTING.md
[repo]: https://github.com/python-jsonschema/check-jsonschema/
[pypi]: https://pypi.org/project/check-jsonschema/
Loading