Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-08-01 20:28:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

contributing: Add requirement for 'Assisted-by' commit field

Browse source 
This adds the requirement for the 'Assisted-by' commit field as voted in
the mailing list to the contribution guide. This allows commits created
with generative tooling to be easily filtered/tracked using automated
tooling, and adopts the guidelines from the ASF with semantics similar
to the Linux kernel recommendation.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
This commit is contained in:
Matteo Golin 2026-07-11 17:37:08 -04:00 • committed by Xiang Xiao
parent c3afd427c4
commit 9748c760be
1 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
CONTRIBUTING.md
View file

@ -109,6 +109,30 @@ Git commit message consists of:
lines, short sentences, or bullet points (see 1.3). lines, short sentences, or bullet points (see 1.3).
4. Blank line. 4. Blank line.
5. Signature (created with `git commit -s`). 5. Signature (created with `git commit -s`).
6. `Assisted-by: ` above the signature (see below)
The `Assisted-by: ` field is required to be present for any and all commits in
which generative tooling/AI tools were used in the assistance of development,
writing commit messages, etc. This field may be omitted if no generative tooling
was used. This follows the [Apache Software Foundation generative tooling
guidance](https://www.apache.org/legal/generative-tooling.html), modifying the
recommended `Generated-by:` tag to `Assisted-by`. This is in line with other
major projects, such as [the Linux kernel
guidelines](https://docs.kernel.org/process/coding-assistants.html).
AI agents **MUST NOT** add `Signed-off-by` tags. Only humans can legally certify
the commit.
The format of this field should follow the following format:
```
Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2]
```
where
* `AGENT_NAME` is the name of the AI tool or framework
* `MODEL_VERSION` is the specific model version used (if available)
* `[TOOL1] [TOOL2]` are optional specialized analysis tools
For example: `Assisted-by: Claude:claude-3-opus coccinelle sparse`
Valid git commit example: Valid git commit example:
@ -133,6 +157,7 @@ auto-rejected until fixed:
1. topic. 1. topic.
2. description. 2. description.
3. signature (`git commit -s`). 3. signature (`git commit -s`).
4. `Assisted-by:`, if applicable (see section 1.5)
Although this seems to repeat rule 1.5, it clearly filters out commits Although this seems to repeat rule 1.5, it clearly filters out commits
with no topic, description, or signature. with no topic, description, or signature.