Skip to content

Commit cdf151f

Browse files
committed
docs: modify contributing guidelines with AI policy
1 parent 883a43f commit cdf151f

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

mkdocs/docs/index.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The Iceberg C++ Project is hosted on GitHub at [https://github.com/apache/iceber
3434
#### Prerequisites
3535

3636
- CMake 3.25 or higher
37-
- C++23 compliant compiler (GCC 11+, Clang 14+, MSVC 2022+)
37+
- C++23 compliant compiler (GCC 14+, Clang 17+, MSVC 2022+)
3838
- Git
3939

4040
#### Building from Source
@@ -129,6 +129,30 @@ pre-commit install
129129

130130
This will setup a git pre-commit-hook that is executed on each commit and will report the linting problems. To run all hooks on all files use `pre-commit run -a`.
131131

132+
### AI-Assisted Contributions
133+
134+
The Apache Iceberg C++ community has the following policy for AI-assisted PRs:
135+
136+
- 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.
137+
- **Calls out unknowns and assumptions**. It's okay to not fully understand some bits of AI generated code. You should comment on these cases and point them out to reviewers so that they can use their knowledge of the codebase to clear up any concerns. For example, you might comment "calling this function here seems to work but I'm not familiar with how it works internally, I wonder if there's a race condition if it is called concurrently".
138+
139+
#### Why fully AI-generated PRs without understanding are not helpful
140+
141+
Today, AI tools cannot reliably make complex changes to the codebase on their own, which is why we rely on pull requests and code review.
142+
143+
The purposes of code review are:
144+
145+
1. Finish the intended task.
146+
2. Share knowledge between authors and reviewers, as a long-term investment in the project. For this reason, even if someone familiar with the codebase can finish a task quickly, we're still happy to help a new contributor work on it even if it takes longer.
147+
148+
An AI dump for an issue doesn’t meet these purposes. Maintainers could finish the task faster by using AI directly, and the submitters gain little knowledge if they act only as a pass through AI proxy without understanding.
149+
150+
Please understand the reviewing capacity is **very limited** for the project, so large PRs which appear to not have the requisite understanding might not get reviewed, and eventually closed or redirected.
151+
152+
#### Better ways to contribute than an “AI dump”
153+
154+
It's recommended to write a high-quality issue with a clear problem statement and a minimal, reproducible example. This can make it easier for others to contribute.
155+
132156
### Submitting Changes
133157

134158
#### Git Workflow
@@ -184,7 +208,3 @@ New to the project? Check out our [good first issues](https://github.com/apache/
184208
### Release Process
185209

186210
Releases are managed by the Apache Iceberg project maintainers. For information about the release process, please refer to the main Iceberg project documentation.
187-
188-
## License
189-
190-
Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

0 commit comments

Comments
 (0)