docs(ai_policy): add an AI attribution policy to CONTRIBUTING.rst · python-gitlab/python-gitlab@8106ca0 · GitHub

1. python-gitlab
2. python-gitlab

Repository navigation

• Code
• Issues16 (16)
• Pull requests15 (15)
• Discussions
• Actions
• Projects
• Security and quality
• Insights

Commit 8106ca0

Browse filesBrowse the repository at this point in the historyBrowse files

JohnVillalovos

committed

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

Require AI generated contributions to indicate so in commit messages. Also add the CONTRIBUTING.rst file to the generated documentation.

1 parent a4cbecb commit 8106ca0
Copy full SHA for 8106ca0

2 files changed

+28Lines changed: 28 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• CONTRIBUTING.rst
• docs
  • index.rst

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎CONTRIBUTING.rst‎

Copy file name to clipboardExpand all lines: CONTRIBUTING.rst

+27Lines changed: 27 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -75,6 +75,9 @@ This creates a clearer project history, and automates our `Releases`_ and change
75	75	* Bad: ``Update documentation for projects``
76	76	* Good: ``docs(projects): update example for saving project attributes``
77	77
	78	+ Also see the :ref:`AI attribution section <ai_attribution_section>` for
	79	+ information on attributing contributions from AI.
	80	+
78	81	Coding Style
79	82	------------
80	83
@@ -90,6 +93,30 @@ To format your code according to our guidelines before committing, run:
90	93	cd python-gitlab/
91	94	tox -e black,isort
92	95
	96	+ .. _ai_attribution_section:
	97	+
	98	+ AI Attribution
	99	+ --------------
	100	+
	101	+ When an AI coding assistant contributed meaningfully to a commit (writing or
	102	+ significantly modifying code, suggesting the fix, generating tests, etc.),
	103	+ add an ``Assisted-by`` trailer to the commit footer::
	104	+
	105	+ Assisted-by: <AgentName>:<ModelVersion>
	106	+
	107	+ Place it alongside any ``Closes:`` or ``BREAKING CHANGE:`` lines. Omit it when
	108	+ the AI contribution was trivial (e.g. a one-word suggestion or only
	109	+ autocomplete) or purely mechanical (running linters, reformatting).
	110	+
	111	+ Example::
	112	+
	113	+ fix(cli): correct the --spam flag
	114	+
	115	+ The --spam flag now says spam three times.
	116	+
	117	+ Closes: #1234
	118	+ Assisted-by: Claude:claude-sonnet-4-6
	119	+
93	120	Running unit tests
94	121	------------------
95	122

Collapse file

‎docs/index.rst‎

Copy file name to clipboardExpand all lines: docs/index.rst

+1Lines changed: 1 addition & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -16,6 +16,7 @@
16	16	changelog
17	17	release-notes
18	18	faq
	19	+ ../CONTRIBUTING
19	20
20	21
21	22	Indices and tables

0 commit comments

Comments

0 (0)