Skip to content

Commit 054756e

Browse files
authored
Enhance contribution guidelines for PR reviews and AI use (#2550)
* Enhance contribution guidelines for PR reviews and AI use * Update contribution guidelines for PR testing
1 parent 7c83b45 commit 054756e

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

docs/dev/contribute.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,36 @@ Each contribution needs to:
4141
- Reviewers: make sure to check the code *before* allowing CI to run!
4242
3. Sustain the overall code quality and standards of the rest of the repo.
4343

44+
### Making Pull Requests Easy to Review
45+
46+
Maintainers try to review contributions quickly, but review time is limited. The easiest pull requests to review are small, focused, and easy to verify.
47+
48+
Before opening a PR, please make sure that:
49+
50+
1. The PR solves one clear problem.
51+
2. The changes are limited to what is necessary.
52+
3. There are no unrelated local changes included.
53+
4. The PR description explains what changed and why.
54+
5. The PR describes how the change was tested, including any platforms that could not be tested locally.
55+
6. Larger refactoring is separated from bug fixes or feature changes.
56+
57+
Some areas of the codebase are more sensitive than they may appear. Small changes can sometimes have large side effects, especially in recently reworked, complex, or platform-specific code. In these cases, reviewers may ask you to reduce the scope, add tests, or follow a specific implementation approach. If you need help testing on a platform you do not have access to, please mention it in the PR and ask for support in the Lemonade Discord.
58+
59+
The fastest way to build trust as a new contributor is to submit small, clear, well-tested PRs that are easy to review and easy to verify.
60+
4461
### AI Policy
4562

46-
Contributors are encouraged to use AI to code their project. However, please review your AI's code yourself before asking another human to review it.
63+
Contributors are welcome to use AI tools while working on Lemonade. However, contributors remain fully responsible for the code they submit.
64+
65+
If you use AI-assisted coding, please make sure that you:
66+
67+
1. Understand the generated code before submitting it.
68+
2. Review the full diff yourself.
69+
3. Remove unrelated or unnecessary changes.
70+
4. Test the result locally where possible.
71+
5. Keep the PR especially small and focused.
72+
73+
AI can make it easy to generate large changes, but large or unfocused changes are harder for maintainers to review and are less likely to be accepted quickly.
4774

4875
Reviewers are expected to use tools like Claude Code's `/review` to save time by analyzing code quality and edge cases. If AI tools generate PR comments, please clearly identify which comments are AI-generated and which are authored by you.
4976

0 commit comments

Comments
 (0)