Skip to content

docs: add AI attribution policy#848

Open
ajbozarth wants to merge 3 commits intogenerative-computing:mainfrom
ajbozarth:docs/ai-attribution-policy
Open

docs: add AI attribution policy#848
ajbozarth wants to merge 3 commits intogenerative-computing:mainfrom
ajbozarth:docs/ai-attribution-policy

Conversation

@ajbozarth
Copy link
Copy Markdown
Contributor

@ajbozarth ajbozarth commented Apr 13, 2026

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

  • Link to Issue: Fixes

Adds an AI attribution policy for the project, partially adopting the
Linux kernel's Assisted-by trailer convention. AI tools add the trailer
by default, so no extra action is required from human contributors.

Changes across five locations:

  • AGENTS.md — New §7 instructing AI assistants to add Assisted-by: <tool> by default and not to add a Signed-off-by in their own name
  • CONTRIBUTING.md — New "AI Tools" subsection under Commit Messages
    documenting the policy for human contributors
  • docs/docs/community/contributing-guide.md — Lighter version of the
    same for new contributors finding the website first
  • .github/PULL_REQUEST_TEMPLATE/*.md — Optional Attribution checkbox
    added to all five PR templates

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code as added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

Attribution

  • AI tools used (Assisted-by trailer added to commits)

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>
@ajbozarth ajbozarth self-assigned this Apr 13, 2026
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 13, 2026
@github-actions
Copy link
Copy Markdown
Contributor

The PR description has been updated. Please fill out the template for your PR to be reviewed.

Copy link
Copy Markdown
Member

@psschwei psschwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

governance file is not updated

@ajbozarth ajbozarth marked this pull request as ready for review April 13, 2026 18:07
@ajbozarth ajbozarth requested a review from a team as a code owner April 13, 2026 18:07
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>
@ajbozarth ajbozarth requested a review from psschwei April 13, 2026 18:11
Copy link
Copy Markdown
Member

@psschwei psschwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@ajbozarth
Copy link
Copy Markdown
Contributor Author

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

@ajbozarth
Copy link
Copy Markdown
Contributor Author

Also if it was not clear, this update is less of a policy change and more of a clarification for agents:
Don't sign-off your commits, instead use assisted-by
This doesn't enforce doing so or require it beyond having it as a default for the project when an agent makes a commit for you.

@psschwei psschwei dismissed their stale review April 13, 2026 20:28

requested change was made

Copy link
Copy Markdown
Member

@psschwei psschwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Copy link
Copy Markdown
Contributor

@planetf1 planetf1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **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:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Suggested change
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.

Copy link
Copy Markdown
Member

@psschwei psschwei Apr 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Add one line per tool used. Use the tool's common name (GitHub Copilot, Cursor, etc.).

Just to clarify multiple are ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants