Skip to content

Commit 1d54ca8

Browse files
authored
docs: ai note for contributions (#5857)
Signed-off-by: Alexander Droste <[email protected]>
1 parent 91f8b58 commit 1d54ca8

File tree

1 file changed

+37
-23
lines changed

1 file changed

+37
-23
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,51 @@
11
# Contributing to Vortex
22

3-
Welcome, and thank you for your interest in contributing to Vortex! We are delighted to receive all forms of community contributions (issues, pull requests, questions).
3+
Welcome, and thank you for your interest in contributing to Vortex! We are delighted to receive all forms of community contributions (issues, pull requests, questions).
44

55
We ask that you read the guidelines below in order to make the process as streamlined as possible.
66

7+
## AI Assistance Notice
8+
9+
> [!IMPORTANT]
10+
> The Vortex project allows AI-assisted contributions, which must be properly
11+
> disclosed in the pull request.
12+
>
13+
> If you are using any kind of AI assistance when contributing to Vortex, please
14+
> disclose this in your pull request, along with the extent to which it was used
15+
> (e.g. writing docs or code generation).
16+
>
17+
> Contributors are required to be able to understand the AI-assisted output and
18+
> reason about it. Should a PR indicate no visible human accountability and
19+
> involvement we reserve the right to close it.
20+
21+
## Code Contributions
22+
23+
The contribution process is outlined below:
24+
25+
1. Start a discussion by creating or commenting on a GitHub Issue (unless it's a very minor change).
26+
27+
2. Implement the change.
28+
- If the change is large, consider posting a draft pull request (PR)
29+
with the title prefixed with [WIP], and share with the team to get early feedback.
30+
- Give the PR a clear, brief description; this will be the commit
31+
message when the PR is merged.
32+
- For significant new functionality, ensure that you write tests to cover that new functionality. Similarly,
33+
for bugfixes, include a test that reproduces the original bug (and that should now pass after the fix).
34+
- Make sure the PR passes all CI tests.
35+
36+
3. Open a PR to indicate that the change is ready for review.
37+
- Ensure that you sign your work via DCO (see below).
38+
- Disclose LLM usage as described in [AI Assistance Notice](#ai-assistance-notice).
39+
740
## Governance
841

942
Vortex is an independent open-source project and not controlled by any single company. The Vortex Project is a sub-project of the Linux Foundation Projects. As such, the governance is subject to the terms of the [Technical Charter](https://vortex.dev/charter.pdf).
1043

1144
## Project Roles
1245

13-
* Contributor: anyone who contributes intellectual property to the common endeavor of the project under the project license.
14-
* Committer: a subset of Contributors, who collectively determine the project's technical direction. Committers have permissions to review & merge code contributions. Unless they are also Maintainers, Committers are non-voting members of the Technical Steering Committee (TSC).
15-
* Maintainer: a subset of Committers, who are also *voting* members of the Technical Steering Committee (TSC). In practice, Maintainers' primary responsibility is to manage membership of the Committers/Maintainers group over time and ensure the long-term health of the project.
46+
- Contributor: anyone who contributes intellectual property to the common endeavor of the project under the project license.
47+
- Committer: a subset of Contributors, who collectively determine the project's technical direction. Committers have permissions to review & merge code contributions. Unless they are also Maintainers, Committers are non-voting members of the Technical Steering Committee (TSC).
48+
- Maintainer: a subset of Committers, who are also _voting_ members of the Technical Steering Committee (TSC). In practice, Maintainers' primary responsibility is to manage membership of the Committers/Maintainers group over time and ensure the long-term health of the project.
1649

1750
### Committers
1851

@@ -54,25 +87,6 @@ See #5495 for background on this change.
5487
If you see something that you think is a bug, create a new Discussion and select "Issue Triage"
5588
for the template. Then fill out the form.
5689

57-
## Code Contributions
58-
59-
The contribution process is outlined below:
60-
61-
1. Start a discussion by creating or commenting on a GitHub Issue (unless it's a very minor change).
62-
63-
2. Implement the change.
64-
* If the change is large, consider posting a draft pull request (PR)
65-
with the title prefixed with [WIP], and share with the team to get early feedback.
66-
* Give the PR a clear, brief description; this will be the commit
67-
message when the PR is merged.
68-
* For significant new functionality, ensure that you write tests to cover that new functionality. Similarly,
69-
for bugfixes, include a test that reproduces the original bug (and that should now pass after the fix).
70-
* Make sure the PR passes all CI tests.
71-
72-
3. Open a PR to indicate that the change is ready for review.
73-
* Ensure that you sign your work via DCO (see below).
74-
* If do you GenAI/LLMs in your contributions **do** mention this.
75-
7690
## Developer Certificate of Origin (DCO)
7791

7892
The Vortex project, like all Linux Foundation projects, uses Developer Certificates of Origin to ensure

0 commit comments

Comments
 (0)