CONTRIBUTING.md: clarify AI usage in commit trailers#166
Conversation
|
|
||
| Use your real name (sorry, no pseudonyms or anonymous contributions.) | ||
|
|
||
| AI tools, services, or assistants may be used to assist with contributions, but |
There was a problem hiding this comment.
Co-authored-by: AI seems fine as long as Signed-off-by is added by a human?
There was a problem hiding this comment.
It's hard to tell that during review 😂. Contributor can add them in description
There was a problem hiding this comment.
I'd like us to encourage an Assisted-by trailer. I think that's better than Co-authored-by and better than just adding into the PR description.
There was a problem hiding this comment.
FYI k8s community forbids AI co-authored-by/assisted-by etc.
https://github.com/kubernetes/community/blob/main/contributors/guide/pull-requests.md#ai-guidance
"Listing AI tooling as a co-author, co-signing commits using an AI tool, or using the assisted-by, co-developed or similar commit trailer is not allowed.":
There was a problem hiding this comment.
It does. I disagree with that conclusion and it is not a CNCF-wide policy so we are not bound by it.
There was a problem hiding this comment.
I also disagree with that conclusion.
CNCF is our parent foundation, yes. However kubernetes arguably being it's biggest project, I figured it needed referencing, for completion, here in this PR.
Made the argument for assisted by at kubecon/cncf con when this was presented on maintainer day. Response was no AI signatures of any kind in the commit message, but you can state assisted by, etc, in the PR.
Also recognizing that this allowance of the assisted-by AI commit trailer, is not a MUST. So I've been using PR text for that.
Also avoiding extra end of file AI assisted comments in code.
| do not add them to `Signed-off-by` or `Co-authored-by` lines. These trailers | ||
| must identify the human contributors certifying or authoring the contribution, | ||
| or project-approved automation accounts used to submit automated contributions. | ||
|
|
There was a problem hiding this comment.
| Instead, we encourage you to add an `Assisted-by` trailer [similar to the Linux kernel](https://docs.kernel.org/process/coding-assistants.html#attribution) denoting the agent and (optionally) the model in use. When multiple assistants are used to author a single commit, multiple `Assisted-by` trailers can be added just like multiple `Signed-off-by` trailers are acceptable when there are multiple human authors. | |
There was a problem hiding this comment.
How about this one
If you want to disclose AI assistance, add that information to the pull request
description. For example, include an `Assisted-by` entry that identifies the tool
and, optionally, the model used.
😂
I would like to hear other maintainers' opinions on this.
My change is only to clarify that signer/author trailers such as Signed-off-by and Co-authored-by should identify real-human contributors, since we have required before.
It is not intended to block or encourage contributors from disclosing AI assistance.
The world changes so fast and maybe CNCF could update their AI policy just like kubernetes.
So, we can encourage contributors to add such information in description.
There was a problem hiding this comment.
I would like to hear other maintainers' opinions on this.
Agreed, happy to hear other opinions.
I do think encourage is the right thing here though. It's helpful information to have, and it's helpful at the commit-locality level instead of requiring someone to open up the GitHub website and look at the PR.
The world changes so fast and maybe CNCF could update their AI policy just like kubernetes.
See cncf/foundation#1285; CNCF is leaving this up to projects right now.
Signed-off-by: Wei Fu <fuweid89@gmail.com>
fuweid
changed the title
4 participants
containerd/containerd#13483 (comment)