Skip to content

Commit 9ef5478

Browse files
committed
Info how to use AI tools added into contributing guide
1 parent 23b3e3c commit 9ef5478

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
@@ -10,6 +10,9 @@
1010
* [PR description](#pr-description)
1111
* [Definition of Done](#definition-of-done)
1212
* [A deliverable is to be considered “done” when](#a-deliverable-is-to-be-considered-done-when)
13+
* [AI assistants](#ai-assistants)
14+
* [“Mark” code with substantial AI-generated portions.](#mark-code-with-substantial-ai-generated-portions)
15+
* [Copyright and licence notices](#copyright-and-licence-notices)
1316
* [Automation](#automation)
1417
* [Pre-commit hook settings](#pre-commit-hook-settings)
1518
* [Code coverage measurement](#code-coverage-measurement)
@@ -109,6 +112,38 @@ Happy hacking!
109112
* Code changes reviewed by at least one peer
110113
* Code changes acked by at least one project owner
111114

115+
## AI assistants
116+
117+
### “Mark” code with substantial AI-generated portions.
118+
119+
Nontrivial and substantial AI-generated or AI-assisted content should be
120+
“marked” in appropriate cases. In deciding how to approach this, consider
121+
adopting one or more of the following recommendations. (This assumes you have
122+
not concluded that a suggestion is a match to some existing third-party code.)
123+
124+
In a commit message, or in a pull request/merge request description field,
125+
identify the code assistant that you used, perhaps elaborating on how it was
126+
used. You may wish to use a trailer like “Assisted-by:” or “Generated-by:”. For
127+
example:
128+
129+
```
130+
Assisted-by: <name of code assistant>
131+
```
132+
133+
In a source file comment, indicate the use of the code assistant. For example:
134+
135+
```
136+
Generated by: <name of code assistant>
137+
```
138+
139+
### Copyright and licence notices
140+
141+
If the contents of an entire file or files in PR were substantially generated
142+
by a code assistant with little to no creative input or modification by you
143+
(which should typically not be the case), copyright protection may be limited,
144+
but it is particularly appropriate to mark the contents of the file as
145+
recommended above.
146+
112147
## Automation
113148

114149
### Pre-commit hook settings

0 commit comments

Comments
 (0)