From 927f4eb5fac32f261423a5a60f1c5a66c089f567 Mon Sep 17 00:00:00 2001 From: Stephen Rosen Date: Wed, 14 Oct 2026 19:50:01 -0500 Subject: [PATCH 1/2] Add new AI policy Co-authored-by: Josh Schwartz --- .github/AI_POLICY.md | 51 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 .github/AI_POLICY.md diff --git a/.github/AI_POLICY.md b/.github/AI_POLICY.md new file mode 100644 index 000000000..c03801e0a --- /dev/null +++ b/.github/AI_POLICY.md @@ -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. From 9a88c928a368f84f0ad586cb3bac84947dd3680c Mon Sep 17 00:00:00 2001 From: Stephen Rosen Date: Fri, 16 Oct 2026 22:22:43 -0500 Subject: [PATCH 2/2] Move contrib doc and update project info links --- CONTRIBUTING.md => .github/CONTRIBUTING.md | 6 ++++++ README.md | 22 ++++++++++++++++------ 2 files changed, 22 insertions(+), 6 deletions(-) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (88%) diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 88% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index ce3c48785..6ea2382be 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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)_ @@ -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 diff --git a/README.md b/README.md index 5360ef5b3..b4f4f634c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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/