Skip to content

Commit bf0e5f0

Browse files
docs(ai_policy): add an AI attribution policy to CONTRIBUTING.rst
Require AI generated contributions to indicate so in commit messages.
1 parent a4cbecb commit bf0e5f0

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

CONTRIBUTING.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,29 @@ To format your code according to our guidelines before committing, run:
9090
cd python-gitlab/
9191
tox -e black,isort
9292
93+
AI Attribution
94+
--------------
95+
96+
When an AI coding assistant contributed meaningfully to a commit (writing or
97+
significantly modifying code, suggesting the fix, generating tests, etc.),
98+
add an ``Assisted-by`` trailer to the commit footer::
99+
100+
Assisted-by: <AgentName>:<ModelVersion>
101+
102+
Place it alongside any ``Closes:`` or ``BREAKING CHANGE:`` lines. Omit it when
103+
the AI contribution was trivial (e.g. a one-word suggestion or only
104+
autocomplete) or purely mechanical (running linters, reformatting).
105+
106+
Example::
107+
108+
fix(reservations): correct overlap check for multi-day bookings
109+
110+
The start-of-day boundary was calculated in UTC rather than the
111+
schedule's local timezone, causing false conflicts.
112+
113+
Closes: #1234
114+
Assisted-by: Claude:claude-sonnet-4-6
115+
93116
Running unit tests
94117
------------------
95118

0 commit comments

Comments
 (0)