docs(ai_policy): add an AI attribution policy to CONTRIBUTING.rst

JohnVillalovos · JohnVillalovos · commit b7443e3917a5 · 2026-06-09T21:43:48.000-07:00
Require AI generated contributions to indicate so in commit messages.

Also add the CONTRIBUTING.rst file to the generated documentation.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -75,6 +75,9 @@ This creates a clearer project history, and automates our `Releases`_ and change
 * Bad:   ``Update documentation for projects``
 * Good:  ``docs(projects): update example for saving project attributes``
 
+Also see the :ref:`AI attribution section <ai_attribution_section>` for
+information on attributing contributions from AI.
+
 Coding Style
 ------------
 
@@ -90,6 +93,30 @@ To format your code according to our guidelines before committing, run:
   cd python-gitlab/
   tox -e black,isort
 
+.. _ai_attribution_section:
+
+AI Attribution
+--------------
+
+When an AI coding assistant contributed meaningfully to a commit (writing or
+significantly modifying code, suggesting the fix, generating tests, etc.),
+add an ``Assisted-by`` trailer to the commit footer::
+
+   Assisted-by: <AgentName>:<ModelVersion>
+
+Place it alongside any ``Closes:`` or ``BREAKING CHANGE:`` lines. Omit it when
+the AI contribution was trivial (e.g. a one-word suggestion or only
+autocomplete) or purely mechanical (running linters, reformatting).
+
+Example::
+
+   fix(cli): correct the --spam flag
+
+   The --spam flag now says spam three times.
+
+   Closes: #1234
+   Assisted-by: Claude:claude-sonnet-4-6
+
 Running unit tests
 ------------------
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -16,6 +16,7 @@
    changelog
    release-notes
    faq
+   ../CONTRIBUTING.rst
 
 
 Indices and tables
