From 17d5ec6b15eda25331205b86106c4ce66bb1805d Mon Sep 17 00:00:00 2001 From: Rot127 Date: Sat, 24 Jan 2026 17:22:31 +0100 Subject: [PATCH 1/2] Add AI guidelines. --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ README.md | 16 ++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..3ba88b6e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ + + +**Your checklist for this pull request** +- [ ] I've used AI tools to generate these changes, fully or partially. +- [ ] I've manually tested all commands and examples in these changes. diff --git a/README.md b/README.md index be93bded..70614499 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,19 @@ Another option is to render the book to any of the formats that are supported by ```sh quarto render . --to pdf --toc ``` + +## Content additions + +New documentation should focus on the value it provides to the user. +The examples and topics should cover common use cases and problems people try to solve, +like "Command X solves problem Y for you." +Figuring out the common use cases is part of contributing to the book. + +## AI guidelines + +It is not allowed to generate documentation solely with AI. +New contributions must be correct and cannot contain _any_ hallucinations. +Beginners should first use a module’s API by experimenting with it, +then write the documentation about it. + +AI can be used to get an initial overview and an idea of where to start experimenting. From fc6ae64c890caae8f82690d43b3bd38bf264c0d7 Mon Sep 17 00:00:00 2001 From: Rot127 Date: Sun, 25 Jan 2026 14:26:15 +0100 Subject: [PATCH 2/2] Mention commands and API in AI part. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 70614499..7c580067 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Figuring out the common use cases is part of contributing to the book. It is not allowed to generate documentation solely with AI. New contributions must be correct and cannot contain _any_ hallucinations. -Beginners should first use a module’s API by experimenting with it, -then write the documentation about it. +Beginners should first use a module’s API or commands by experimenting with it, +then write the documentation. AI can be used to get an initial overview and an idea of where to start experimenting.