Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ New contributors should start with issues labeled [`good first issue`](https://g
Before starting larger work:

- Search open issues and pull requests to avoid duplicates.
- Open an issue to discuss your approach before writing code for significant changes.
- Start a [GitHub Discussion](https://github.com/NVIDIA/NemoClaw/discussions) before writing code for significant changes.
- Open an issue after the proposal has enough scope and design detail for maintainer review.
- For questions, open a [GitHub Discussion](https://github.com/NVIDIA/NemoClaw/discussions) or comment on a related issue.

## Before You Open an Issue
Expand All @@ -42,6 +43,19 @@ Open an issue when you encounter one of the following situations.
- A feature proposal with a design — not a "please build this" request.
- Security vulnerabilities must follow [SECURITY.md](SECURITY.md) — **not** GitHub issues.

Use [GitHub Discussions](https://github.com/NVIDIA/NemoClaw/discussions) for questions, design exploration, and larger feature proposals before implementation.
Maintainers may ask you to move broad or still-forming proposals from an issue to a discussion so the design can settle before code review.

## Community Response Expectations

NemoClaw is an alpha project, and maintainer availability varies with release, security, and stability work.
Issues, discussions, and pull requests are reviewed on a best-effort basis.
The project does not publish guaranteed response or review timelines.

Maintainers prioritize work using severity, security impact, release readiness, reproducibility, maintainer capacity, and community impact.
For public roadmap context and current priorities, see [Current Priorities](README.md#current-priorities).
That section is a planning aid, not a commitment that a specific issue or feature will ship in a specific release.

## Prerequisites

Install the following before you begin.
Expand Down Expand Up @@ -194,8 +208,9 @@ For user-skill definitions, docs-to-skills validation, release-prep regeneration
## Pull Requests

We welcome contributions. Every PR requires maintainer review before merge. To keep the review queue healthy, limit the number of open PRs you have at any time to fewer than 10.

Maintainers review all incoming PRs on a best-effort basis. Straightforward fixes typically receive initial feedback sooner than large or complex changes. If a PR has not received a response after two weeks, a polite comment asking for an update is welcome.
Maintainers review pull requests according to project priority, security impact, release readiness, and reviewer availability.
PRs that solve issues with Priority set to Urgent or High are more likely to receive earlier review when maintainers have capacity.
For substantial features or behavior changes, start with a GitHub Discussion before opening a large implementation PR.

### DCO Sign-Off

Expand Down
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,17 @@ Refer to the following pages on the official documentation website for more info

## Community

- [Discord](https://discord.gg/XFpfPv9Uvx)
- [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.


| Need | Channel |
|------|---------|
| Setup or usage questions | [GitHub Discussions](https://github.com/NVIDIA/NemoClaw/discussions) or [Discord](https://discord.gg/XFpfPv9Uvx) |
| Reproducible bugs | [GitHub Issues](https://github.com/NVIDIA/NemoClaw/issues) |
| Feature proposals | Start with [GitHub Discussions](https://github.com/NVIDIA/NemoClaw/discussions), then open an issue when the scope is clear |
| Current priorities | [Current Priorities](#current-priorities) |
| Contribution help | [CONTRIBUTING.md](CONTRIBUTING.md) |
| Security vulnerabilities | Use the private channels in [SECURITY.md](SECURITY.md); do not open public issues |

## Contributing

Expand All @@ -70,6 +78,19 @@ Use one of the private reporting channels described in [SECURITY.md](SECURITY.md

For security bulletins and PSIRT policies, visit the [NVIDIA Product Security](https://www.nvidia.com/en-us/security/) portal.

## Current Priorities

NemoClaw's current priorities are maintained here as a public orientation point for contributors and community members.
This list is not a delivery commitment, support promise, or fixed roadmap; priorities can change as maintainers respond to security, quality, platform readiness, and community feedback.

- Improve install and onboarding reliability across tested platforms.
- Strengthen sandbox hardening, credential handling, and network-policy defaults.
- Validate local and routed inference behavior for supported provider paths.
- Keep documentation, troubleshooting guidance, and agent skills aligned with supported workflows.

For specific scoped work, use [GitHub Issues](https://github.com/NVIDIA/NemoClaw/issues) and start broader proposals in [GitHub Discussions](https://github.com/NVIDIA/NemoClaw/discussions).
Security vulnerabilities must use the private reporting channels in [SECURITY.md](SECURITY.md), not public issues.

## Notice and Disclaimer

This software automatically retrieves, accesses or interacts with external materials. Those retrieved materials are not distributed with this software and are governed solely by separate terms, conditions and licenses. You are solely responsible for finding, reviewing and complying with all applicable terms, conditions, and licenses, and for verifying the security, integrity and suitability of any retrieved materials for your specific use case. This software is provided "AS IS", without warranty of any kind. The author makes no representations or warranties regarding any retrieved materials, and assumes no liability for any losses, damages, liabilities or legal consequences from your use or inability to use this software or any retrieved materials. Use this software and the retrieved materials at your own risk.
Expand Down
Loading