Skip to content

Guideline for contributions - #3369

Open
PandaeDo wants to merge 6 commits into
eclipse-score:mainfrom
qorix-group:vohae_contrib_rules
Open

PandaeDo wants to merge 6 commits into
eclipse-score:mainfrom
qorix-group:vohae_contrib_rules

Conversation

@PandaeDo

@PandaeDo PandaeDo commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Add guideline for contributions also for preparation of the contributor training. We'll have a section especially for that

Motivation

Eclipse publicly shows commit activity per individual and per supporting member company
(project "Who's involved" page).
Commits are credited to their human author, including the parts an AI assistant wrote.
This makes the volume of a contribution visible and attractive, which is why the new rules ask for
substance instead of volume and for a disclosure of AI use (as required by the Eclipse Generative
AI Usage Guidelines, made applicable via wp__policies).

AI disclosure

This PR was written with AI assistance. I reviewed every change and take responsibility for it.

Assisted-by: Anthropic Claude Opus 5.5 (claude-opus-5-5)

@github-actions

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-3369: https://eclipse-score.github.io/score/pr-3369/

#. **Reviewable in one sitting.** Keep content changes small enough that a reviewer can
understand all of them at once. As orientation, aim for about 400 changed lines of
hand-written content or less. Larger content needs a reason in the description and, for new
topics, an issue first (:need:`doc__issue_guideline`).

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.

New topics will go more through https://eclipse-score.github.io/score/pr-3369/contribute/contribution_request/feature_request.html, not only Issues, see description

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Changed it

#. **AI-assisted contributions** follow the
`Eclipse Generative AI Usage Guidelines <https://www.eclipse.org/projects/guidelines/genai/>`_:
the contributor has reviewed and understands every line and can defend it in review; AI use is
disclosed (``Assisted-by:`` trailer; for files largely generated by AI, the AI disclosure

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 PR seems to be AI assisted, where I can find this disclosure statement?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Your're right. The PR was written with AI assistance. Would propose to update our processes because this is a generic topic and after that we can refine the guideline as well.

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.

State?!

eclipse-score/contributor_training is merged, so the ToDo link is replaced
by the repository. The sentence "It contains an exercise on the scope and
size of a pull request" is removed: checked against its task issues,
TRAINING.md and SOLUTIONS.md, the training has no such exercise yet. The
next step in this list points to the scope and size rules instead.

Assisted-by: Claude Code (claude-opus-5-5)
masc2023
masc2023 previously approved these changes Nov 11, 2026
Signed-off-by: Volker Häussler <volker.haeussler@qorix.ai>

This branch has not been deployed

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

Labels

None yet

Projects

Status: Backlog
Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants