Skip to content

Commit ed64c7d

Browse files
authored
docs: add AI-assisted contribution policy (#512)
1 parent eed779e commit ed64c7d

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,30 @@ This is a pure Rust project, so only `cargo` is needed. Here are some common com
4545
2. Open a pull request on the project's GitHub page. Provide a clear description of your changes and why they are necessary.
4646
3. Wait for reviews and address any feedback. Once the pull request is approved and merged, your changes will be part of the project.
4747

48+
## AI-Assisted Contributions
49+
50+
Apache Paimon Rust has the following policy for AI-assisted pull requests:
51+
52+
- The PR author should **understand the core ideas** behind the implementation **end-to-end** and be able to justify the design and code during review.
53+
- **Call out unknowns and assumptions.** It is acceptable not to fully understand some details of AI-generated code, but authors should identify these cases and point them out to reviewers. This allows reviewers to apply their knowledge of the codebase and evaluate potential concerns, such as correctness, concurrency, compatibility, or performance risks.
54+
55+
### Why fully AI-generated PRs without understanding are not helpful
56+
57+
AI tools cannot reliably make complex changes to Apache Paimon Rust on their own, which is why we rely on pull requests and code review.
58+
59+
The purposes of code review are:
60+
61+
1. Complete the intended task correctly.
62+
2. Share knowledge between authors and reviewers as a long-term investment in the project.
63+
64+
A fully AI-generated contribution without sufficient author understanding does not meet these purposes. Maintainers could use AI tools directly, while contributors acting only as a proxy gain little knowledge of the project.
65+
66+
Review capacity is limited, so large pull requests that appear to lack the required understanding may not be reviewed and may eventually be closed or redirected.
67+
68+
### Better ways to contribute than an "AI dump"
69+
70+
Consider writing a high-quality issue with a clear problem statement and a minimal reproducible example. This often makes it easier for the community to investigate the problem and develop an appropriate solution.
71+
4872
### Read the design docs
4973

5074
For a deeper understanding of the project, read the design documentation available on our [Paimon Rust](https://paimon.apache.org/docs/rust/).

0 commit comments

Comments
 (0)