Skip to content

Commit 6be1205

Browse files
authored
[contributing] Add guidelines regarding AI (#4512)
2 parents e0019a8 + ba91e2a commit 6be1205

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,41 @@ not use platform `#ifdef`s (or other platform-conditional logic) outside of thos
266266
**CPP13.** Avoid compilation warnings.<br>
267267
**CPP14.** To mock free functions and external APIs, wrap them with `MockableSingleton`.<br>
268268

269+
### Text
270+
271+
Prescriptive guidelines concerning text and written communication, including but not limited to:
272+
PR descriptions, commit messages, comments, and documentation.
273+
274+
**TXT1.** Be clear, precise, informative, and organized.<br>
275+
**TXT2.** Avoid filler text or fluff.<br>
276+
**TXT3.** Avoid repetition.<br>
277+
**TXT4.** Use references, quotes, citations, or links to provide context, substantiate claims,
278+
and increase reliability.<br>
279+
**TXT5.** Express the same idea more than once only to add relevant information, improve precision,
280+
provide a different perspective, or help clarify complexity.<br>
281+
282+
### AI
283+
284+
Prescriptive guidelines concerning the use of Artificial Intelligence (AI) when contributing to
285+
Multipass, in particular generative AI and LLMs.
286+
287+
**AI1.** Every contribution must be authored by human beings (one or more),
288+
possibly with the help of AI tools. In addition to code contributions, this applies to issues, pull
289+
requests, discussions, and any other comments or communications, regardless of the platform.<br>
290+
**AI2.** Contributors are free to use any tools they see fit, including AI tools, provided they do
291+
so lawfully and ethically.<br>
292+
**AI3.** Git commits must have a human author, with a valid human-managed email address.<br>
293+
**AI4.** The author(s) of a contribution must be able to explain the contribution in detail,
294+
including any code or textual changes.<br>
295+
**AI5.** Contributors must refrain from submitting code, text, or any other content that they don't
296+
fully understand.<br>
297+
**AI6.** Contributors must submit only modifications that they have reviewed thoroughly,
298+
especially if it includes AI-generated content.<br>
299+
**AI7.** When using AI, contributors should make an extra effort to ensure good information density
300+
(i.e. high signal-to-noise ratio). This includes code and text.<br>
301+
**AI8.** Authors are ultimately responsible for their entire contributions,
302+
including all components, contents, format, presentation, and communication.<br>
303+
269304
# Further Information
270305

271306
- https://github.com/canonical/desktop-engineering/blob/main/project-repo/review-process.md

0 commit comments

Comments
 (0)