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..7c580067 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 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.