Skip to content

Commit fed3083

Browse files
developersebgeoffreynyaga
authored andcommitted
[contributing] Add guidelines regarding AI (#4512)
1 parent 8fec0f1 commit fed3083

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
@@ -265,6 +265,41 @@ not use platform `#ifdef`s (or other platform-conditional logic) outside of thos
265265
**CPP13.** Avoid compilation warnings.<br>
266266
**CPP14.** To mock free functions and external APIs, wrap them with `MockableSingleton`.<br>
267267

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

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

0 commit comments

Comments
 (0)