diff --git a/docs/contributing.rst b/docs/contributing.rst index fdda6a146..46be2549a 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -40,6 +40,45 @@ Before you start, familiarize yourself with two documents: governs how the project's code is used and distributed. +.. _contributing_ai: + +Acceptable use of AI +~~~~~~~~~~~~~~~~~~~~ + +AI assistance is welcome in contributions of any kind. +The repository is tuned for GitHub Copilot: +it includes instructions and agents tailored to the project, +along with documentation skills sourced from the approved +`copilot-collections `__ set +(see :ref:`contributing_copilot`). +Try Copilot first; +other assistants are just as acceptable. + +Whichever tool you use, authorship stays with you: +submit AI-assisted work as your own, without AI attribution, +and take full responsibility for its contents. + +A few ground rules: + +- Use AI freely to write pull request descriptions; + a clear statement of intent and rationale helps reviewers. + +- Write commit messages and code comments yourself: + they're the project's long-term memory + and follow :ref:`conventions ` of their own. + +- Draft documentation with AI if it helps, + then edit the result to comply with the :ref:`doc_style_guide`. + Running the documentation review skills is mandatory + for documentation contributions. + + +Bulk or low-effort AI-generated pull requests +that disregard the project's practices +are closed at the maintainers' sole discretion, +without extended discussion. + + Ways to contribute ------------------ diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index b6cbb10e1..94bd9883f 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -225,6 +225,9 @@ so reviewers can follow the reasoning and collaborate on it. error messages, and code structure. See the :ref:`coding_style_guide` for the full set of patterns and their rationale. +If you develop with AI assistance, +see :ref:`contributing_ai` first. + Test ~~~~ diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 2f001f0eb..65a8d4526 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -110,6 +110,9 @@ The :ref:`command-line reference ` pages under are generated from the source, not edited by hand. See :ref:`contributing_doc_generation` for how they're produced. +If you draft with AI assistance, +see :ref:`contributing_ai` first. + Test ~~~~