Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/contributing/03-contribution-guideline.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ The process described here has several goals:
1. Create a meaningful description of the pull request or reference the related issue. The pull request template explains what the content should include, please read it.
1. Ask for merging your contribution by removing the draft marker. Repository maintainers (see [Code Ownership](#code-ownership)) are notified automatically, but you can also reach out to people directly on Slack if you want a review from a specific person.

## Usage of Generative AI Tools

The metal-stack project generally accepts contributions that make use of generative AI tools. We believe that AI can increase productivity and improve quality when developers use it *consciously*. Using this technology unconsciously, however, comes with risks for the project and the community, which is why we expect contributors to respect the following aspects for AI-generated contents:

- Compliance: The contributor is responsible for the disclosed sources and ensures that it complies with the Open Source definition, copyright and license regulations of the metal-stack project.
- Communication: Comments, motivations and issues are genuinely written by humans.
- Transparency: Commits where substantial parts were generated by AI must include:
- Commit labels for the review process, like: `Generated-By: [tool name] <your commit message>` .
- The names of the tools that were used with AI should be included in the pull request description. For this, you can find a snippet in the pull request template. As we usually squash commits when we merge, the commit labeling described above is not sufficient.
- Code Understanding: We expect full understanding of the contributed code. The code must have been executed and tested in some way by the contributor. The contribution guideline's overall style and design choices must be followed.
- Quality over Quantity: It is very easy to generate a lot of code with the help of AI in a very short amount of time. By contrast, reviewing large pull requests takes exponentially longer as they grow in size. Therefore, contributions are expected to be minimal. Large changes must be discussed in issues as usual and discussed in the community.

## General Objectives

This section contains language-agnostic topics that all metal-stack projects are trying to follow.
Expand Down