docs: add community norms and expand Find an Issue guidance#91
Conversation
✅ Deploy Preview for relaxed-faloodeh-7fa6f1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Rate limit exceeded
To continue reviewing without waiting, purchase usage credits in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe contributing guide expands the "Find an Issue" workflow with Projects-board discovery, component categorisation, assignment and progress rules, LFX Mentoring onboarding, and reorders "Submitting Pull Requests" to reference AI-use guidance and moves "Reporting Issues" after PR guidance. ChangesContributing guide update
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
R-Lawton
force-pushed
the
add-community-norms
branch
from
125c4f4 to
c90fb91
Compare
david-martin
left a comment
david-martin
left a comment
There was a problem hiding this comment.
Thanks for getting this changes together quickly @R-Lawton
Couple of comments, and looped in @mikenairn about PR commit etiquette
Let's aim to land these soon. I won't hold merging with just the nits i highlighted
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/contributing.md (1)
43-43: ⚡ Quick winAlign assignment flow wording to avoid mixed signals.
Line 43 tells contributors to assign themselves when interested, while Line 47 asks them not to self-assign immediately. Please make these steps sequential in one clear rule (comment first, then assign when confirmed ready) to avoid confusion for new contributors.
Proposed wording tweak
-A list of good first issues can be found from the Kuadrant Github [projects board](https://github.com/orgs/Kuadrant/projects/18/views/7). These issues are categorised per component. If you see an issue you're interested in progressing, mark yourself as an assignee and update the issue status to `In Progress`. +A list of good first issues can be found from the Kuadrant GitHub [projects board](https://github.com/orgs/Kuadrant/projects/18/views/7). These issues are categorised per component. If you see an issue you're interested in, leave a comment first; once confirmed and you're ready to start, mark yourself as an assignee and update the issue status to `In Progress`.Also applies to: 47-47
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/contributing.md` at line 43, Combine the two conflicting sentences about self-assignment into one clear rule: replace the separate instructions that say "mark yourself as an assignee and update the issue status to `In Progress`" and the later "do not self-assign immediately" with a single step that tells contributors to first comment on the issue to express interest and confirm intent, wait for maintainer or team confirmation if required, and only then assign themselves and set the status to `In Progress`; update the contributing guidance text (the two sentences that mention assigning yourself and not self-assigning) so it reads as one sequential instruction (comment to express interest → wait for confirmation if needed → assign and mark In Progress).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/contributing.md`:
- Line 43: Replace all occurrences of the incorrect product name casing "Github"
with the correct "GitHub" in src/contributing.md (the sentence containing the
projects board link and the other flagged lines). Locate the strings that read
"Kuadrant Github" (and any other "Github" instances) and update them to
"Kuadrant GitHub" to ensure consistent, user-facing documentation.
---
Nitpick comments:
In `@src/contributing.md`:
- Line 43: Combine the two conflicting sentences about self-assignment into one
clear rule: replace the separate instructions that say "mark yourself as an
assignee and update the issue status to `In Progress`" and the later "do not
self-assign immediately" with a single step that tells contributors to first
comment on the issue to express interest and confirm intent, wait for maintainer
or team confirmation if required, and only then assign themselves and set the
status to `In Progress`; update the contributing guidance text (the two
sentences that mention assigning yourself and not self-assigning) so it reads as
one sequential instruction (comment to express interest → wait for confirmation
if needed → assign and mark In Progress).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: dfc8298a-e6de-487d-8166-2af74e384abd
📒 Files selected for processing (1)
src/contributing.md
R-Lawton
force-pushed
the
add-community-norms
branch
from
00532d5 to
779dcba
Compare
… contributor journey Signed-off-by: R-Lawton <rlawton@redhat.com>
R-Lawton
force-pushed
the
add-community-norms
branch
from
779dcba to
d833d39
Compare
5 participants
What
Why
The community has grown and we're seeing patterns that aren't great for sustainability — repeated DMs to maintainers, people assigning themselves to already-claimed issues, and AI-generated contributions that haven't been verified. This adds friendly, welcoming guidance to set expectations without being unwelcoming.
Summary by CodeRabbit