Skip to content

Commit a323ac7

Browse files
jhammand-v-b
andauthored
doc: add ai use policy to contributing guide (#3769)
* doc: add ai use policy to contributing guide * add changelog entry * Update docs/contributing.md Co-authored-by: Davis Bennett <davis.v.bennett@gmail.com> --------- Co-authored-by: Davis Bennett <davis.v.bennett@gmail.com>
1 parent 4acebeb commit a323ac7

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

changes/3769.doc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add AI-assisted code policy to the contributing guide.

docs/contributing.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,32 @@ If you have an idea about a new feature or some other improvement to Zarr, pleas
3636

3737
We very much welcome ideas and suggestions for how to improve Zarr, but please bear in mind that we are likely to be conservative in accepting proposals for new features. The reasons for this are that we would like to keep the Zarr code base lean and focused on a core set of functionalities, and available time for development, review and maintenance of new features is limited. But if you have a great idea, please don't let that stop you from posting it on GitHub, just please don't be offended if we respond cautiously.
3838

39+
## AI-assisted contributions
40+
41+
AI coding tools are increasingly common in open source development. These tools are welcome in Zarr-Python, but the same standards apply to all contributions regardless of how they were produced — whether written by hand, with AI assistance, or generated entirely by an AI tool.
42+
43+
### You are responsible for your changes
44+
45+
If you submit a pull request, you are responsible for understanding and having fully reviewed the changes. You must be able to explain why each change is correct and how it fits into the project.
46+
47+
### Communication must be your own
48+
49+
PR descriptions, issue comments, and review responses must be in your own words. The substance and reasoning must come from you. Using AI to polish grammar or phrasing is fine, but do not paste AI-generated text as comments or review responses.
50+
51+
### Review every line
52+
53+
You must have personally reviewed and understood all changes before submitting. If you used AI to generate code, you are expected to have read it critically and tested it. The PR description should explain the approach and reasoning — do not leave it to reviewers to figure out what the code does and why.
54+
55+
### Keep PRs reviewable
56+
57+
Generating code with AI is fast; reviewing it is not. A large diff shifts the burden from the contributor to the reviewer. PRs that cannot be reviewed in reasonable time with reasonable effort may be closed, regardless of their potential usefulness or correctness. Use AI tools not only to write code but to prepare better, more reviewable PRs — well-structured commits, clear descriptions, and minimal scope.
58+
59+
If you are planning a large AI-assisted contribution (e.g., a significant refactor or a new subsystem), **open an issue first** to discuss the scope and approach with maintainers. Maintainers may also request that large changes be broken into smaller, reviewable pieces.
60+
61+
### Documentation
62+
63+
The same principles apply to documentation. Zarr has domain-specific semantics (chunked storage, codec pipelines, Zarr v2/v3 format details) that AI tools frequently get wrong. Do not submit documentation that you haven't carefully read and verified.
64+
3965
## Contributing code and/or documentation
4066

4167
### Forking the repository

0 commit comments

Comments
 (0)