Add TRG 11 — Generative AI guidelines (11.01 & 11.02) - #1558
Add TRG 11 — Generative AI guidelines (11.01 & 11.02)#1558mgarciaLKS with Copilot wants to merge 2 commits into
Conversation
tom-rm-meyer-ISST
left a comment
There was a problem hiding this comment.
Thanks for proposing! Overall the Handbook is well integrated. I would go for a few additions to cover non-code. Further, I recommend to increase separation in TRG11 like in TRG 7 as we repeat ourselves here.
For the future (or now) we should also keep an eye on duplication filters.
|
|
||
| ## Disclosing AI assistance in commits | ||
|
|
||
| When a commit contains content that was generated with the assistance of Generative AI, the commit message **must** include an `Assisted-by:` trailer that names the tool **and** the concrete model (including its version) that was used. |
There was a problem hiding this comment.
| When a commit contains content that was generated with the assistance of Generative AI, the commit message **must** include an `Assisted-by:` trailer that names the tool **and** the concrete model (including its version) that was used. | |
| When a commit contains content that was generated with the assistance of Generative AI, the commit message **MUST** include an `Assisted-by:` trailer that names the tool **and** the concrete model (including its version) that was used in scheme `[Provider] [Model-Family] ([Version/ID])`. Refer to the example below. |
normative language following RFC 2219 are written in UPPERCASE
|
|
||
| **Notes:** | ||
|
|
||
| - The trailer goes at the **end** of the commit message, together with any other trailers (e.g. `Signed-off-by:`). |
There was a problem hiding this comment.
didn't find signed-off-by in the committer handbook. Since it has been deprecated in 2021, please use another example.
| **Notes:** | ||
|
|
||
| - The trailer goes at the **end** of the commit message, together with any other trailers (e.g. `Signed-off-by:`). | ||
| - Always record the **specific model and version** that produced the contribution (for example `GitHub Copilot (Claude-Opus-4.8-2026-06-16)` or `Google (gemini-2.5-pro)`), not just the vendor name. |
There was a problem hiding this comment.
| - Always record the **specific model and version** that produced the contribution (for example `GitHub Copilot (Claude-Opus-4.8-2026-06-16)` or `Google (gemini-2.5-pro)`), not just the vendor name. |
Duplication of the statement before the example
|
|
||
| ## AI usage policy (`AI_POLICY.md`) | ||
|
|
||
| Each repository **should** provide an `AI_POLICY.md` file at its root that makes the project's stance on Generative AI transparent to every contributor. |
There was a problem hiding this comment.
| Each repository **should** provide an `AI_POLICY.md` file at its root that makes the project's stance on Generative AI transparent to every contributor. | |
| Each repository **SHOULD** provide an `AI_POLICY.md` file at its root that makes the project's stance on Generative AI transparent to every contributor. |
| The `AI_POLICY.md` file should clarify, at minimum: | ||
|
|
||
| - Whether the usage of Generative AI is **allowed, restricted, or forbidden** in the repository. | ||
| - Which **models or tools** are recommended or permitted. |
There was a problem hiding this comment.
Do you have an example at hand? That would be great because the Handbook provides also requirements, that we as committers need to consider like anti-plagiarism mechanisms.
To elaborate on that: In her talk on the OCX Lina Böcker explained some of these. Hopefully the playlist will soon be filled. What's important: copyright infringement must be ensured by the toolchain, how the models are trained or tooling afterwards. To reduce these wirsks we should rely on duplication filters to run against available repos. Github Copilot has duplication filter. Theia IDE has a button to check against public repos. I've not yet used it, but the scancode toolkit would be common tooling to check against public repos, if I understood things correctly.
Maybe we should state that "To reduce the risk of plagiarism, the providers / models used SHOULD perform duplication checks OR the contributors check their AI-generated code against public repositories."
| **Notes:** | ||
|
|
||
| - The disclosure describes the **degree** of AI generation. Choose one of `minimally`, `largely`, or `entirely`. | ||
| - The **year** is the year of the initial creation, following [TRG 7.02](/docs/release/trg-7/trg-7-02). |
There was a problem hiding this comment.
| - The **year** is the year of the initial creation, following [TRG 7.02](/docs/release/trg-7/trg-7-02). |
separation of concerns is in TRG 7.02
| # Assisted-by: GitHub Copilot (Claude-Opus-4.8-2026-06-16) | ||
| ####################################################################### | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I would like to add an example for TRG 7.07 in the footer like
## NOTICE
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
AI Disclosure: This file was [largely | entirely] AI-generated. The AI-generated portions are made available under CC0-1.0 and not subject to the project's license. The human contributor has reviewed and verified that the code is correct.
- SPDX-License-Identifier: CC-BY-4.0 and CC0-1.0
- Assisted-By: GitHub Copilot (Claude-Opus-4.8-2026-06-16)
- SPDX-FileCopyrightText: 202x {Owner}
- Source URL: https://github.com/eclipse-tractusx/<myrepo>/<link_to_doc_or_doc_dir> (+)
| # which is available at | ||
| # https://creativecommons.org/licenses/by/4.0/legalcode. | ||
| # | ||
| # AI Disclosure: This file was [minimally | largely | entirely] AI-generated. |
There was a problem hiding this comment.
| # AI Disclosure: This file was [minimally | largely | entirely] AI-generated. | |
| # AI Disclosure: This file was [largely | entirely] AI-generated. |
| * License for the specific language governing permissions and limitations | ||
| * under the License. | ||
| * | ||
| * AI Disclosure: This file was [minimally | largely | entirely] AI-generated. |
There was a problem hiding this comment.
| * AI Disclosure: This file was [minimally | largely | entirely] AI-generated. | |
| * AI Disclosure: This file was [largely | entirely] AI-generated. |
|
|
||
| - [Eclipse Foundation Project Handbook — Generative AI](https://www.eclipse.org/projects/handbook/#genai) | ||
| - [TRG 11.01 - Generative AI usage and contribution](/docs/release/trg-11/trg-11-01) | ||
| - [TRG 7.02 - License and Copyright header](/docs/release/trg-7/trg-7-02) |
There was a problem hiding this comment.
| - [TRG 7.02 - License and Copyright header](/docs/release/trg-7/trg-7-02) | |
| - [TRG 7.02 - License and Copyright header](../trg-7/trg-7-02) | |
| - [TRG 7.07 - Legal Notice for Non-Code](../trg-7/trg-7-06) |
I would also use relative file paths in all files due to portabilitby: https://docusaurus.io/docs/next/markdown-features/links
👋 Hi! I'm the KIT Master Builder — your Eclipse Tractus-X KIT architect.
The Eclipse Foundation FOSS governance (Project Handbook — Generative AI) requires that AI-assisted contributions be disclosed: substantial AI-generated code must be dual-licensed under
CC0-1.0, commits must carry anAssisted-by:trailer naming the model, and projects should publish an AI usage policy. This adds a new TRG 11 family documenting those rules.What's included
docs/release/trg-11/trg-11-01.md— Generative AI usage and contribution. Allowed-usage conditions, the mandatoryAssisted-by: <tool> (<model-version>)commit trailer, and theAI_POLICY.mdrecommendation (allowed/restricted/forbidden, recommended models, quality + test requirements).docs/release/trg-11/trg-11-02.md— AI disclosure and licensing in headers. The AI Disclosure block (minimally | largely | entirely), combinedSPDX-License-Identifier(Apache-2.0 AND CC0-1.0/CC-BY-4.0 AND CC0-1.0), and copy-paste header examples for code and non-code files.docs/release/trg-11/_category_.json— sidebar category "TRG 11 - Generative AI".sidebars.js— registers TRG 11 (autogenerated pattern) after TRG 10.Key decisions
.mdstructure (status table →## Why→## Description) and absolute/docs/release/...cross-links, matching TRG 7.02. Status isDraft.AI_POLICY.mdis documented as a TRG 11.01 requirement rather than committed here, keeping scope to the requested deliverable. Can scaffold a concrete policy file in a follow-up if wanted.How to review
Assisted-by:format match the issue.Compliance check
.markdownlint.yaml): 0 errors on both files.sidebars.jsloads via Node and containsrelease/trg-11; all internal link targets exist.Example header introduced by TRG 11.02:
Thanks for trusting me to build this with you! 🏗️ Feel free to ask me anything in the comments.