Repository navigation
Add AI usage guideline #851
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
masc2023
merged 2 commits into
eclipse-score:main
from
qorix-group:vohae_ai_usage_guideline
Oct 29, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
120 changes: 120 additions & 0 deletions
120
process/process_areas/process_management/guidance/ai_usage_guideline.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| .. | ||
| AI Disclosure: This file was largely 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 content is correct. | ||
| SPDX-License-Identifier: Apache-2.0 AND CC0-1.0 | ||
| Assisted-by: Anthropic Claude Opus 5.5 (claude-opus-5-5) | ||
|
|
||
| .. _ai_usage_guideline: | ||
|
|
||
| AI Usage Guideline | ||
| ################## | ||
|
|
||
| .. gd_guidl:: Usage of Generative AI | ||
| :id: gd_guidl__ai_usage | ||
| :status: valid | ||
| :version: 1 | ||
| :tags: process_management | ||
|
|
||
| This guideline defines how the | ||
| `Eclipse Generative AI Usage Guidelines <https://www.eclipse.org/projects/guidelines/genai/>`_, | ||
| made applicable by :need:`wp__policies`, are applied in the project. It applies to every | ||
| contribution to the project, independent of the repository and the kind of content, | ||
| including issues, pull requests and review comments. | ||
|
|
||
| The Eclipse guidelines remain the governing document. This guideline only makes them | ||
| concrete where the Eclipse guidelines leave a choice to the project. | ||
|
|
||
| Responsibility | ||
| ============== | ||
|
|
||
| #. The contributor (:need:`Contributor <rl__contributor>`) shall be responsible for every | ||
| change they submit, independent of whether it was created with the help of a generative AI | ||
| tool. The contributor shall have reviewed and understood every change and shall be able to | ||
| defend it in the review. | ||
| #. The use of a generative AI tool shall not reduce the scope of the review, the acceptance | ||
| criteria or the automated checks that apply to a contribution. | ||
|
|
||
| Disclosure | ||
| ========== | ||
|
|
||
| #. The contributor shall disclose the use of a generative AI tool, if the AI contributed in a | ||
| way for which a human would be given credit. | ||
|
|
||
| No disclosure is required for trivial assistance, for example spelling and grammar | ||
| corrections, formatting, code completion of single statements or rote boilerplate that | ||
| the contributor modifies and supplements. | ||
|
|
||
| #. The disclosure shall be given where the AI-assisted content is created: | ||
|
|
||
| - for changes in a repository, as ``Assisted-by:`` trailer in the message of every affected | ||
| commit; | ||
| - for issues, pull request descriptions and comments whose text is AI-assisted, as | ||
| ``Assisted-by:`` line in that text. | ||
|
|
||
| #. The AI tool shall be identified in the following format, as complete as possible: | ||
|
|
||
| .. code-block:: text | ||
|
|
||
| Assisted-by: <Provider> <Model> (<Version/ID>) | ||
|
|
||
| Examples: | ||
|
|
||
| .. code-block:: text | ||
|
|
||
| Assisted-by: GitHub Copilot (GPT-4o-2024-08-06) | ||
| Assisted-by: Anthropic Claude Opus 5.5 (claude-opus-5-5) | ||
|
|
||
| If several AI tools were used, one ``Assisted-by:`` line per tool shall be given. | ||
|
|
||
| #. A file that is largely or entirely AI-generated shall carry, in addition to the standard | ||
| copyright header of the project, an AI disclosure block directly below it: | ||
|
|
||
| .. code-block:: text | ||
|
|
||
| AI Disclosure: This file was largely 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 content is correct. | ||
| SPDX-License-Identifier: Apache-2.0 AND CC0-1.0 | ||
| Assisted-by: <Provider> <Model> (<Version/ID>) | ||
|
|
||
| The copyright header of the project shall stay unchanged, so that the automated copyright | ||
| checks keep working. | ||
|
|
||
| Review and Merge | ||
| ================ | ||
|
|
||
| #. Every merge into a repository of the project shall be approved by a human committer | ||
| (:need:`Committer <rl__committer>`). AI agents or bots shall not push directly to protected | ||
| branches or merge pull requests. | ||
| #. A committer may reject an AI-assisted contribution that they do not understand or are not | ||
| willing to maintain, or request that it is split into smaller pull requests. | ||
| #. A committer shall request the missing disclosure, if a contribution appears to be | ||
| AI-assisted and is not disclosed. | ||
|
|
||
| Functional Safety and Security | ||
| ============================== | ||
|
|
||
| #. AI-assisted content in safety or security related work products shall follow the same | ||
| process, review and verification requirements as any other content. No additional rules | ||
| apply. | ||
| #. AI tools used to create or verify work products shall be identified and evaluated like any | ||
| other tool according to Tool Management (:need:`wf__tool_evaluate_tool`). A qualification of | ||
| AI tools is not intended. Therefore the output of an AI tool shall not be used as work product | ||
| or verification evidence without human review. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.