Skip to content

docs: clarify community response expectations#4729

Merged
cv merged 3 commits into
mainfrom
codex/issue-3829-community-expectations
Jun 4, 2026
Merged

docs: clarify community response expectations#4729
cv merged 3 commits into
mainfrom
codex/issue-3829-community-expectations

Conversation

@wscurran

@wscurran wscurran commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

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

  • Add README community channel guidance by request type.
  • Add a README Current Priorities section with non-commitment roadmap language.
  • Document best effort issue, discussion, and PR review expectations in CONTRIBUTING.
  • Route substantial feature proposals through GitHub Discussions before large implementation PRs.
  • Note that PRs linked to Urgent or High priority issues are more likely to receive earlier review when maintainers have capacity.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Verification

  • npx prek run --all-files passes
  • npm test passes
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • make docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: Will Curran wcurran@nvidia.com

Summary by CodeRabbit

  • Documentation
    • Clarified contribution flow: start with a Discussion for substantial work, open an issue when scope/design are ready for review
    • Added “Community Response Expectations” noting alpha status, best-effort review timing, and maintainer prioritization criteria
    • Introduced a “Current Priorities” section and mapped channels for contribution types, including private reporting for security issues

Signed-off-by: Will Curran <wcurran@nvidia.com>
@wscurran wscurran self-assigned this Jun 3, 2026
@copy-pr-bot

copy-pr-bot Bot commented Jun 3, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 5465e54c-b4f6-4821-9a5c-3e4aa80bc9a0

📥 Commits

Reviewing files that changed from the base of the PR and between bbca695 and c232d0c.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

Updated 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.

Changes

Contributor-Facing Expectations and Project Visibility

Layer / File(s) Summary
Contribution workflow and response expectations
CONTRIBUTING.md
Specified a two-step GitHub Discussion-to-issue flow for significant changes; added “Community Response Expectations” describing alpha status and best-effort review model and maintainer prioritization factors; updated Pull Request review criteria and priority handling.
Community channels and current priorities
README.md
Replaced simple link bullets with a “Join the NemoClaw community” paragraph and a table mapping contribution types to channels; added a “Current Priorities” section listing public focus areas and guidance for scoped work and private security reporting.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related issues

Possibly related PRs

  • NVIDIA/NemoClaw#4620: Also modifies CONTRIBUTING.md pull-request and review-expectations guidance.

Suggested labels

documentation

Suggested reviewers

  • cv

Poem

🐰 A little rabbit hops to say,
Docs now show the thoughtful way.
Start with talk, then open doors,
Alpha notes and priority scores.
Join our patchwork, hop along today.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: clarify community response expectations' directly reflects the primary objective of documenting and publishing community response and review expectations.
Linked Issues check ✅ Passed The PR fully addresses all acceptance criteria from issue #3829: publishes response expectations (best-effort, non-guaranteed), establishes GitHub Discussions as preferred channel for large proposals, includes a 'Current Priorities' section as roadmap source, and provides maintainer guidance without overpromising timelines.
Out of Scope Changes check ✅ Passed All changes in CONTRIBUTING.md and README.md are directly aligned with the decision objectives from issue #3829; no out-of-scope modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/issue-3829-community-expectations

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. Documentation-only changes to README.md and CONTRIBUTING.md update contributor/community guidance and current-priorities wording. They cannot affect runtime behavior or real assistant user flows, so no E2E jobs are needed.

Optional E2E

  • None.

New E2E recommendations

  • None.

@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

E2E Scenario Advisor Recommendation

Required scenario E2E: None
Optional scenario E2E: None

Workflow run

Full scenario advisor summary

E2E Scenario Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required scenario E2E

  • None. Docs-only changes to CONTRIBUTING.md and README.md do not affect scenario E2E runtime, scenario metadata, expected-state contracts, suite definitions, workflows, onboarding helpers, or suite scripts.

Optional scenario E2E

  • None.

Relevant changed files

  • None.

@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

@wscurran wscurran marked this pull request as ready for review June 3, 2026 22:18
@wscurran wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance area: project-management Taxonomy, triage, workflow, roadmap, or project process v0.0.59 Release target labels Jun 3, 2026
@wscurran wscurran requested a review from miyoungc June 3, 2026 22:21
@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor

Findings: 1 needs attention, 2 worth checking, 0 nice ideas
Since last review: 1 prior item resolved, 0 still apply, 2 new items found

Review findings

🛠️ Needs attention

  • Record the maintainer decisions requested by the linked issue: Issue project: decide response expectations and public roadmap source #3829 is framed as a decision issue before public README and CONTRIBUTING updates, with acceptance criteria requiring maintainers to agree on response/review expectations, choose the roadmap source, and choose the preferred route for larger feature proposals. The diff implements concrete choices, but the provided linked issue context has zero comments and no explicit decision record showing those choices were agreed before publication.
    • Recommendation: Add or point to a maintainer decision record in the issue or PR that confirms the published best-effort response expectations, README Current Priorities as the roadmap source, and GitHub Discussions as the route for larger proposals.
    • Evidence: Issue body: “Before updating public README and CONTRIBUTING guidance, maintainers should decide...” and acceptance criteria: “Maintainers agree...”, “Maintainers choose...”. Linked issue context reports comments: 0. Diff adds these choices in CONTRIBUTING.md and README.md.

🔎 Worth checking

  • Source-of-truth review needed: Issue project: decide response expectations and public roadmap source #3829 decision source for public guidance: The advisor marked localized patch analysis as needs_followup.
    • Recommendation: Identify the invalid state, source boundary, source-fix constraint, regression test, and removal condition before merging the localized behavior.
    • Evidence: Issue project: decide response expectations and public roadmap source #3829 asks maintainers to decide before docs updates; linked issue comments are empty in the provided context.
  • Check whether reintroducing alpha wording matches recent docs direction (README.md:54): This PR adds “NemoClaw is an alpha project” to README.md and similarly to CONTRIBUTING.md. Recent README history includes a docs change titled “remove alpha software references”, so this may conflict with the current public positioning unless maintainers intentionally want alpha wording for response expectations.
    • Recommendation: Confirm that “alpha project” is the desired public terminology here, or rephrase the best-effort response guidance without reintroducing alpha status language.
    • Evidence: README.md line 54 adds “NemoClaw is an alpha project...”. CONTRIBUTING.md line 51 adds similar wording. Drift context shows recent README history: “docs: remove alpha software references (docs: remove alpha software references #4590)”.

🌱 Nice ideas

  • None.
Since last review details

Current findings:

  • Source-of-truth review needed: Issue project: decide response expectations and public roadmap source #3829 decision source for public guidance: The advisor marked localized patch analysis as needs_followup.
    • Recommendation: Identify the invalid state, source boundary, source-fix constraint, regression test, and removal condition before merging the localized behavior.
    • Evidence: Issue project: decide response expectations and public roadmap source #3829 asks maintainers to decide before docs updates; linked issue comments are empty in the provided context.
  • Record the maintainer decisions requested by the linked issue: Issue project: decide response expectations and public roadmap source #3829 is framed as a decision issue before public README and CONTRIBUTING updates, with acceptance criteria requiring maintainers to agree on response/review expectations, choose the roadmap source, and choose the preferred route for larger feature proposals. The diff implements concrete choices, but the provided linked issue context has zero comments and no explicit decision record showing those choices were agreed before publication.
    • Recommendation: Add or point to a maintainer decision record in the issue or PR that confirms the published best-effort response expectations, README Current Priorities as the roadmap source, and GitHub Discussions as the route for larger proposals.
    • Evidence: Issue body: “Before updating public README and CONTRIBUTING guidance, maintainers should decide...” and acceptance criteria: “Maintainers agree...”, “Maintainers choose...”. Linked issue context reports comments: 0. Diff adds these choices in CONTRIBUTING.md and README.md.
  • Check whether reintroducing alpha wording matches recent docs direction (README.md:54): This PR adds “NemoClaw is an alpha project” to README.md and similarly to CONTRIBUTING.md. Recent README history includes a docs change titled “remove alpha software references”, so this may conflict with the current public positioning unless maintainers intentionally want alpha wording for response expectations.
    • Recommendation: Confirm that “alpha project” is the desired public terminology here, or rephrase the best-effort response guidance without reintroducing alpha status language.
    • Evidence: README.md line 54 adds “NemoClaw is an alpha project...”. CONTRIBUTING.md line 51 adds similar wording. Drift context shows recent README history: “docs: remove alpha software references (docs: remove alpha software references #4590)”.

Workflow run details

This is an automated advisory review. A human maintainer must make the final merge decision.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 19a17ea and bbca695.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • README.md

Comment thread CONTRIBUTING.md Outdated
Comment thread README.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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

Suggested change
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.

wscurran and others added 2 commits June 3, 2026 15:34
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@wscurran wscurran enabled auto-merge (squash) June 3, 2026 22:35
@cv cv disabled auto-merge June 4, 2026 01:26
@cv cv merged commit 2c26945 into main Jun 4, 2026
21 checks passed
@cv cv deleted the codex/issue-3829-community-expectations branch June 4, 2026 01:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build area: project-management Taxonomy, triage, workflow, roadmap, or project process chore Build, CI, dependency, or tooling maintenance v0.0.59 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

project: decide response expectations and public roadmap source

3 participants