docs: clarify community response expectations#4729
Conversation
Signed-off-by: Will Curran <wcurran@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughUpdated CONTRIBUTING.md and README.md to publish NemoClaw's contribution workflow and response expectations, require GitHub Discussions before scoped issues for major work, add a “Community Response Expectations” section, and publish a “Current Priorities” section with channel guidance. ChangesContributor-Facing Expectations and Project Visibility
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
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)
Comment |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
E2E Scenario Advisor RecommendationRequired scenario E2E: None Full scenario advisor summaryE2E Scenario AdvisorBase: Required scenario E2E
Optional scenario E2E
Relevant changed files
|
|
🌿 Preview your docs: https://nvidia-preview-pr-4729.docs.buildwithfern.com/nemoclaw |
PR Review AdvisorFindings: 1 needs attention, 2 worth checking, 0 nice ideas Review findings🛠️ Needs attention
🔎 Worth checking
🌱 Nice ideas
Since last review detailsCurrent findings:
This is an automated advisory review. A human maintainer must make the final merge decision. |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@CONTRIBUTING.md`:
- Line 52: Replace the unhyphenated adjectival phrase "best effort" in the
sentence "Issues, discussions, and pull requests are reviewed on a best effort
basis." with the hyphenated form "best-effort" so it reads "Issues, discussions,
and pull requests are reviewed on a best-effort basis." to correct the
adjectival usage and maintain consistency in CONTRIBUTING.md.
In `@README.md`:
- Line 54: Update the sentence that currently reads "maintainers review issues,
discussions, and pull requests on a best effort basis" to hyphenate
"best-effort" so it reads "...on a best-effort basis"; locate and edit the
sentence in the README line containing "maintainers review issues, discussions,
and pull requests" and replace "best effort" with "best-effort" to conform to
standard technical prose.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 21e79349-075a-4d28-99cf-fadb34108f62
📒 Files selected for processing (2)
CONTRIBUTING.mdREADME.md
| - [GitHub Discussions](https://github.com/NVIDIA/NemoClaw/discussions) | ||
| - [GitHub Issues](https://github.com/NVIDIA/NemoClaw/issues) | ||
| Join the NemoClaw community to ask questions, share feedback, and report issues. | ||
| NemoClaw is an alpha project, so maintainers review issues, discussions, and pull requests on a best effort basis without guaranteed response timelines. |
There was a problem hiding this comment.
Use “best-effort” in the response model sentence.
Line 54 should hyphenate “best-effort” for standard technical prose style.
Suggested edit
-NemoClaw is an alpha project, so maintainers review issues, discussions, and pull requests on a best effort basis without guaranteed response timelines.
+NemoClaw is an alpha project, so maintainers review issues, discussions, and pull requests on a best-effort basis without guaranteed response timelines.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| NemoClaw is an alpha project, so maintainers review issues, discussions, and pull requests on a best effort basis without guaranteed response timelines. | |
| NemoClaw is an alpha project, so maintainers review issues, discussions, and pull requests on a best-effort basis without guaranteed response timelines. |
🧰 Tools
🪛 LanguageTool
[grammar] ~54-~54: Use a hyphen to join words.
Context: ...discussions, and pull requests on a best effort basis without guaranteed response...
(QB_NEW_EN_HYPHEN)
🤖 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 `@README.md` at line 54, Update the sentence that currently reads "maintainers
review issues, discussions, and pull requests on a best effort basis" to
hyphenate "best-effort" so it reads "...on a best-effort basis"; locate and edit
the sentence in the README line containing "maintainers review issues,
discussions, and pull requests" and replace "best effort" with "best-effort" to
conform to standard technical prose.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary
This PR documents NemoClaw's public community response and review expectations without promising fixed response timelines. It also clarifies where larger proposals should start and adds a README current-priorities section as the public roadmap orientation point.
Related Issue
Fixes #3829
Changes
Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Signed-off-by: Will Curran wcurran@nvidia.com
Summary by CodeRabbit