Skip to content

Commit 8d9c078

Browse files
authored
docs(contributing): add PR expectations and AI-assisted contribution policy (#562)
* docs(CONTRIBUTO): updating guidelines * docs(CONTRIBUTO): phrasing
1 parent 25545e9 commit 8d9c078

18 files changed

Lines changed: 504 additions & 0 deletions

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Zoo Code is a community-driven project, and we deeply value every contribution.
2020
- [Before You Contribute](#before-you-contribute)
2121
- [Finding & Planning Your Contribution](#finding--planning-your-contribution)
2222
- [Development & Submission Process](#development--submission-process)
23+
- [Pull Request Expectations](#pull-request-expectations)
24+
- [AI-Assisted Contributions](#ai-assisted-contributions)
2325
- [Legal](#legal)
2426

2527
## Before You Contribute
@@ -136,6 +138,32 @@ pnpm install
136138
- **Weekly In-depth Review:** Comprehensive assessment.
137139
- **Iterate promptly** based on feedback.
138140

141+
### Pull Request Expectations
142+
143+
Pull requests should be reviewable, tested, and maintainable. Before opening a PR, please make sure that:
144+
145+
- The change is scoped to a specific issue, bug, or improvement.
146+
- You can explain what the change does and why it is correct.
147+
- You have tested the change locally where practical.
148+
- You are willing to respond to review feedback and make reasonable follow-up changes.
149+
- The PR does not require maintainers to substantially rewrite, redesign, or take ownership of the implementation before it can be merged.
150+
151+
Maintainers may close PRs that are incomplete, too broad, inactive, not aligned with the project direction, or that create disproportionate review or maintenance burden. Closing a PR is not a judgment on the contributor; it is a maintainer decision that the change cannot be accepted in its present form.
152+
153+
### AI-Assisted Contributions
154+
155+
Use of AI tools is allowed, but contributors remain fully responsible for their submissions.
156+
157+
If you use AI tools to help create a PR, you must:
158+
159+
- Review and understand every meaningful change.
160+
- Be able to explain the implementation and tradeoffs in your own words.
161+
- Test the change yourself. If testing is impractical for your environment, explain why in the PR description and describe how reviewers can verify the change instead.
162+
- Verify that generated code is correct, necessary, and compatible with the project license.
163+
- Consider disclosing AI assistance in the PR description when it materially shaped the code, tests, or design — this helps reviewers give better feedback.
164+
165+
Please do not submit AI-generated changes that you do not understand or cannot maintain through review. Maintainers may close PRs that appear substantially AI-assisted but lack human verification, clear rationale, or review follow-through.
166+
139167
## Legal
140168

141169
By contributing, you agree your contributions will be licensed under the Apache 2.0 License, consistent with Zoo Code's licensing.

locales/ca/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

locales/de/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

locales/es/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

locales/fr/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)