docs: add AI attribution policy#848
docs: add AI attribution policy#848ajbozarth wants to merge 3 commits intogenerative-computing:mainfrom
Conversation
Documents the project's AI tool policy across contributor-facing locations: optional Assisted-by trailer for humans, default-on for AI assistants, and an Attribution checkbox in all PR templates. Assisted-by: Claude Code Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
psschwei
left a comment
There was a problem hiding this comment.
governance file is not updated
Add pointer to CONTRIBUTING.md attribution conventions in the existing 'Use of AI tools' paragraph. Assisted-by: Claude Code Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
psschwei
left a comment
There was a problem hiding this comment.
These days I assume all code I see is AI generated. So I'm not sure the value of flagging it in a commit, but it also doesn't really hurt anything (as long as AGENTS.md will add it automatically, I don't want to have to go back and edit my commits)
The LF document we're basing this on (https://docs.kernel.org/process/coding-assistants.html#attribution) suggests the reason they are adding this line is to "track the evolving role of AI in the development process". Is that something we plan on tracking / care about?
A bit, but they're looking at tools and models in their trailers, whereas I've only put the AI Assistant name since IMHO I use multiple models on any given commit and tools come and go quickly. So to me this is more about automatically marking code as AI assisted as more of an reference |
|
Also if it was not clear, this update is less of a policy change and more of a clarification for agents: |
psschwei
left a comment
There was a problem hiding this comment.
LGTM
I would let at least one other person review before merging.
Remove redundant intro sentence and 'For AI assistants:' label — the whole document is addressed to AI assistants. Assisted-by: Claude Code Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
planetf1
left a comment
There was a problem hiding this comment.
I suggest the ambiguity is resolved
|
|
||
| Found a bug, workaround, or pattern? Update the docs: | ||
|
|
||
| - **Issue/workaround?** → Add to Section 7 (Common Issues) in this file |
There was a problem hiding this comment.
| - **Issue/workaround?** → Add to Section 9 (Common Issues) in this file |
The section moved (you may want to replace with a proper link)
| ## 7. Timing | ||
| ## 7. AI Attribution | ||
|
|
||
| The project requires sign-offs — use `-s` when committing. Do not add a separate `Signed-off-by` line in the AI's own name. Add an `Assisted-by:` trailer to the commit footer by default: |
There was a problem hiding this comment.
this reads as a little confusing - it seems to tell an AI. to use -s when commiting and to not add a line, yet by definition it is what -s does. Maybe something like this
| The project requires sign-offs — use `-s` when committing. Do not add a separate `Signed-off-by` line in the AI's own name. Add an `Assisted-by:` trailer to the commit footer by default: | |
| Commits require a Signed-off-by trailer from the human author (the human | |
| runs `git commit -s`). AI agents must not add a Signed-off-by in the | |
| tool's own name — instead, add an Assisted-by: trailer to the commit | |
| footer by default: |
My AI agent complained on this ambiguity.
There was a problem hiding this comment.
This could be a little confusing too, it could be read as saying that the human will be the one to run the git commit command. Maybe something like this:
Commits require a Signed-off-by trailer from the human author, which is done
by running `git commit -s`. Do not add an additional Signed-off-by ...
| Assisted-by: Claude Code | ||
| Assisted-by: IBM Bob | ||
| ``` | ||
|
|
There was a problem hiding this comment.
| Add one line per tool used. Use the tool's common name (GitHub Copilot, Cursor, etc.). |
Just to clarify multiple are ok
Misc PR
Type of PR
Description
Adds an AI attribution policy for the project, partially adopting the
Linux kernel's
Assisted-bytrailer convention. AI tools add the trailerby default, so no extra action is required from human contributors.
Changes across five locations:
AGENTS.md— New §7 instructing AI assistants to addAssisted-by: <tool>by default and not to add aSigned-off-byin their own nameCONTRIBUTING.md— New "AI Tools" subsection under Commit Messagesdocumenting the policy for human contributors
docs/docs/community/contributing-guide.md— Lighter version of thesame for new contributors finding the website first
.github/PULL_REQUEST_TEMPLATE/*.md— Optional Attribution checkboxadded to all five PR templates
Testing
Attribution