You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Refine Copilot and CONTRIBUTING guidelines for clarity and conciseness (#2150)
* Refactor Copilot and CONTRIBUTING guidelines for clarity and conciseness
* Streamline and condense PR review guidelines in CONTRIBUTING.md for improved clarity and usability.
* Apply suggestions from code review
* fix(pre_commit): 🎨 auto format pre-commit hooks
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+94Lines changed: 94 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -286,6 +286,100 @@ To run tests with coverage:
286
286
uv run pytest --cov=supervision
287
287
```
288
288
289
+
## 🔍 PR Review Guidelines
290
+
291
+
These guidelines help reviewers provide consistent, actionable feedback efficiently. Your goals: validate completeness, identify risks, provide actionable feedback, and highlight quality gaps.
292
+
293
+
### Overall Recommendation
294
+
295
+
Start with a clear recommendation using these levels:
296
+
297
+
- 🟢 **Approve** — Ready to merge
298
+
- 🟡 **Minor Suggestions** — Improvements recommended but not blocking
299
+
- 🟠 **Request Changes** — Must address issues before merge
300
+
- 🔴 **Block** — Critical issues require major rework
301
+
302
+
Example: `🟠 Request Changes — Missing unit tests for PolygonMerger and no mkdocs entry.`
303
+
304
+
### PR Completeness
305
+
306
+
Verify requirements are met (✅ Complete / ⚠️ Incomplete / ❌ Missing / 🔵 N/A):
307
+
308
+
- [ ] Clear description of what changed and why
309
+
- [ ] Tests added/updated for new functionality or bug fixes
**DO:** Use inline GitHub comments with suggestions, explain *why* (not just *what*), distinguish blocking vs. nice-to-have, acknowledge good work, run linter if needed (`uv run pre-commit run --all-files`)
378
+
379
+
**DON'T:** Mention line numbers in summary (use inline comments), give vague feedback, nitpick style (defer to tools), assume knowledge of conventions, block on minor issues
380
+
381
+
**Tone:** Be respectful, specific, pragmatic, and consistent. Focus on actionable feedback that moves PRs toward merge.
382
+
289
383
## 📄 License
290
384
291
385
By contributing, you agree that your contributions will be licensed under an [MIT license](../LICENSE.md).
0 commit comments