Skip to content

Commit a693686

Browse files
wikkykclaude
andcommitted
docs: add AI contribution policy and PR guidelines
Add AI-Assisted Contributions section to CONTRIBUTING.md covering authorship, transparency, human oversight, and quality expectations. Add general PR scope guidelines (complete, self-contained, reasonable size, dependent PRs). Reference CONTRIBUTING.md from AGENTS.md. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent ab8a2fb commit a693686

2 files changed

Lines changed: 26 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@ Key v1alpha2 change: unified `NetworkDevices` array replacing v1alpha1's split o
9999
- Proxmox client mocks generated via `make mockgen` (`.mockery.yaml`)
100100
- E2E tests in `test/e2e/` require a live Proxmox VE instance; controlled by PR labels
101101

102+
## Contributing
103+
104+
See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines, paying particular attention to the [AI-Assisted Contributions](CONTRIBUTING.md#ai-assisted-contributions) section which covers authorship, transparency, and quality expectations for AI-assisted work.
105+
102106
## Rules
103107

104108
**Always:**

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ git push origin feature-branch
3333
* Provide a clear and descriptive title for your changes.
3434
* Include details about the changes and the problem it solves.
3535
* Reference any relevant issues or pull requests.
36+
* Keep changes complete and self-contained — partial implementations are not mergeable and stall review.
37+
* Keep PRs focused and of reasonable size; smaller, focused changes are easier and faster to review and merge.
38+
* A chain of dependent PRs is a good way to break up large contributions.
3639

3740
The ionos-cloud/cluster-api-provider-proxmox repo requires approval to run actions on external PRs.
3841
This includes linters, unit (go) and e2e tests, scanners.
@@ -67,6 +70,25 @@ Make sure that it's lint-free and that generated files are up to date.
6770
make lint test verify
6871
```
6972

73+
## AI-Assisted Contributions
74+
75+
All guidelines in this document apply to AI-assisted contributions. The rules in this section are in addition to those.
76+
77+
AI tools are welcome at any stage.
78+
79+
**Authorship**: The git commit author must be the person responsible for the contribution. Any agent that produced code must be attributed with a `Co-Authored-By:` trailer. The only exception is a commit that solely modifies an agent instructions file (e.g. `AGENTS.md`) where the agent may be the author and the person a co-author.
80+
81+
**Transparency**: AI agents must be clearly identified as such. We don't mind interacting with agents; we do mind agents masquerading as people. Do not have an agent interact on issues or pull requests while presenting as a human contributor.
82+
83+
**Human oversight**: The human contributor is responsible for the entire contribution and must oversee it end to end — code, tests, and description.
84+
85+
**Quality**: A non-draft pull request must represent completed work:
86+
- Includes relevant tests covering the changes
87+
- All tests and linters pass (`make lint test verify`)
88+
- Correct attribution on all commits
89+
90+
Pull requests that violate these standards will be closed.
91+
7092
## Documentation
7193
Ensure that your changes are reflected in the documentation. If you are introducing new features, update the documentation accordingly.
7294

0 commit comments

Comments
 (0)