Skip to content
Open
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
9 changes: 8 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
<!-- Filling this template is mandatory -->
#
# IT IS NOT ALLOWED TO GENERATE THE PR DESCRIPTION WITH AI!
#
# See CONTRIBUTING.md for our AI guidelines.
#


<!-- Filling this template is mandatory -->

**Your checklist for this pull request**
- [ ] I've documented or updated the documentation of every API function and struct this PR changes.
Expand Down
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,32 @@ Coding style
- We provide a `.clang-format` for C code.
- Python files should be formatted with `black`.

AI guidelines
------------
Using AI for contributions is generally allowed (see the exceptions below).
Please be aware that everything has to be tested thoroughly.
The larger the PR, the more rigid our requirements are.
We ask you to specifically check the tests. They should not be verbose
or contain duplications but should still provide the maximum amount of coverage.

> [!NOTE]
> We highly recommend limiting AI usage to small or repetitive changes.
> The rule of thumb is:
>
> _Only tasks you can very quickly check for correctness are suitable for AI._

> [!IMPORTANT]
> It is forbidden to let AI write the PR description or commit messages!
>
> This rule helps us maintainers because generated text is incredibly verbose,
> hard to read, and too time-intensive to understand.
> This rule also serves as an indicator.
> If you struggle to explain what the change does, AI was not the right tool.

Translations with AI are, of course, allowed.
If you use it, please write simple, short sentences in your native language
so the AI doesn't translate them too floridly.

Support
-------

Expand Down
Loading