-
Notifications
You must be signed in to change notification settings - Fork 18
docs: see PR review guidelines #74
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughDocumentation updated to clarify PR review feedback practices. Adds guidance on when to use "Request Changes" versus "Comment" for code reviews, and refines wording around the Scout approach to emphasize proactive ownership and timely feedback. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/CONTRIBUTING.md (1)
299-299: Minor: Clarify what "Code style is inconsistent" means in context."Code style is inconsistent" as an objective problem could be ambiguous if your team uses automated linting/formatting tools. If style violations are auto-fixable or auto-enforced, contributors might perceive this as an optional concern rather than a blocker.
Consider clarifying whether this refers to violations of documented style guidelines that aren't caught by automation, to set clearer expectations.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/CONTRIBUTING.md(1 hunks)
🔇 Additional comments (1)
docs/CONTRIBUTING.md (1)
293-308: Strong clarification of PR review expectations.The new "Reviewing PRs" section directly addresses the issue raised in #451 by providing concrete guidance on when to use "Request Changes" versus "Comment". The distinction between objective problems (reject) and optional improvements (comment) is clear, and the examples are practical.
The updated Scout approach wording is also more action-oriented and emphasizes proactive ownership—improvements over the original phrasing.
Time Submission Status
|
|
@zolotokrylin, I am unable to assign a reviewer manually. This PR is ready for review, thanks! |
Description:
Contributors and reviewers now see clear guidance on when to reject a PR versus when to leave a comment.
Close: https://github.com/holdex/pr-time-tracker-webhooks/issues/451
Preview: https://github.com/dante4rt/developers/blob/59b09b57833c7f0582a67a329775574865264b1a/docs/CONTRIBUTING.md#reviewing-prs
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.