Skip to content

docs: add CONTRIBUTING.md#4079

Open
okwn wants to merge 1 commit into
NVIDIA:mainfrom
okwn:docs/add-contributing
Open

docs: add CONTRIBUTING.md#4079
okwn wants to merge 1 commit into
NVIDIA:mainfrom
okwn:docs/add-contributing

Conversation

@okwn
Copy link
Copy Markdown

@okwn okwn commented May 22, 2026

Summary

Adds CONTRIBUTING.md

Testing

N/A

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added repository status overview document capturing metadata, structure, build/test details, and code quality notes.
    • Added comprehensive repository mapping documentation including package layout, test organization, and platform support matrix.
    • Added PR candidate selection and planning documentation with analysis criteria and prioritized recommendations.

Review Change Stack

@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 22, 2026

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
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 2026

📝 Walkthrough

Walkthrough

This PR adds four planning and documentation files to the NemoClaw repository fork. The changes establish the current repository state, map its structure, define PR candidate selection criteria with a prioritized list of ten candidates, and provide a detailed action plan for five selected PRs including fork steps and verification commands.

Changes

NemoClaw Repository Planning Documentation

Layer / File(s) Summary
Repository baseline and structure mapping
00_STATE.md, 01_REPO_MAP.md
00_STATE.md provides a comprehensive snapshot of repository metadata, structure, build/test/lint/CI configuration, test status, open issues by category, and key observations. 01_REPO_MAP.md documents repository hierarchy, branches, package layout, test organization, documentation entry points, agent skills catalog, network policies, credentials/providers, and platform support matrix.
PR candidate screening and prioritization
05_PR_CANDIDATES.md
Selection criteria document defining freshness, priority weighting, clarity, scope, and contributor fit. Lists ten prioritized candidates (#4075#3980) with status, labels, branches, summaries, risk assessments, and affected files. Includes "Issues Worth Addressing" table and contributing notes covering commit format, SPDX headers, Biome linting, test commands, DCO, and CI checks.
Selected PR implementation plan and execution steps
06_SELECTED_5_PR_PLAN.md
Enumerates five selected PRs with per-PR rationale, scope metrics, affected files, fork action steps, and verification commands. Provides overall selection criteria, consolidated summary table by PR (files, risk, platform, priority), recommended execution order, and contributing notes with guidance on commits, headers, linting, testing, sign-off, and code owner review.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A hop through the docs, so shiny and new!
State, maps, and candidates—a developer's zoo.
Five PRs await with their action-plan guide,
The fork moves forward with clarity and pride. 🌿

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title 'docs: add CONTRIBUTING.md' is misleading. The changeset adds four documentation files (00_STATE.md, 01_REPO_MAP.md, 05_PR_CANDIDATES.md, 06_SELECTED_5_PR_PLAN.md), but does not include CONTRIBUTING.md. Update the title to accurately reflect the actual files added, such as 'docs: add repository state, map, and PR planning documents' or provide the actual CONTRIBUTING.md file to match the title.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Warning

⚠️ This pull request might be slop. It has been flagged by CodeRabbit slop detection and should be reviewed carefully.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 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 `@00_STATE.md`:
- Line 1: Add the required SPDX license header to the top of 00_STATE.md: insert
a one-line SPDX copyright/ license declaration (including
SPDX-License-Identifier: Apache-2.0) and a short copyright holder line as the
first lines of the file so the file complies with the repository rule for all
source files.

In `@01_REPO_MAP.md`:
- Line 1: Add the required SPDX copyright/license header for Apache-2.0 at the
top of the Markdown file before the H1; specifically, open the file that
contains the line "# 01_REPO_MAP.md — NemoClaw" and insert the standardized SPDX
header (copyright notice + SPDX-License-Identifier: Apache-2.0) as the very
first lines above the existing H1.

In `@05_PR_CANDIDATES.md`:
- Line 1: Add the required SPDX license header at the very top of the file by
inserting the SPDX copyright and license lines (e.g., include an
SPDX-FileCopyrightText line for copyright holder and an SPDX-License-Identifier:
Apache-2.0 line) before the existing content or heading in 05_PR_CANDIDATES.md
so the file complies with the repository rule that every source/markdown file
include an SPDX header.

In `@06_SELECTED_5_PR_PLAN.md`:
- Line 1: The file 06_SELECTED_5_PR_PLAN.md is missing the required SPDX license
header; prepend a standard SPDX copyright notice and the "Apache-2.0" SPDX
identifier at the very top of 06_SELECTED_5_PR_PLAN.md so the file complies with
the repository rule that every source file (including .md) contains an SPDX
header for copyright and Apache-2.0 licensing.
🪄 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: 22ac1cbe-e5b1-4ef7-8233-95f76af326e2

📥 Commits

Reviewing files that changed from the base of the PR and between cf588ed and 8015faa.

📒 Files selected for processing (4)
  • 00_STATE.md
  • 01_REPO_MAP.md
  • 05_PR_CANDIDATES.md
  • 06_SELECTED_5_PR_PLAN.md

Comment thread 00_STATE.md
@@ -0,0 +1,124 @@
# 00_STATE.md — NemoClaw
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 | 🟠 Major | ⚡ Quick win

Add the required SPDX license header at the top of the file.

00_STATE.md currently starts directly with the title and is missing the required SPDX copyright/license header.

Suggested fix
+<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+
 # 00_STATE.md — NemoClaw

As per coding guidelines, "**/*.{js,ts,tsx,jsx,sh,yaml,yml,json,md,mdx}: Every source file must include an SPDX license header for copyright and Apache-2.0 license".

📝 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
# 00_STATE.md — NemoClaw
<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. -->
<!-- SPDX-License-Identifier: Apache-2.0 -->
# 00_STATE.md — NemoClaw
🤖 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 `@00_STATE.md` at line 1, Add the required SPDX license header to the top of
00_STATE.md: insert a one-line SPDX copyright/ license declaration (including
SPDX-License-Identifier: Apache-2.0) and a short copyright holder line as the
first lines of the file so the file complies with the repository rule for all
source files.

Comment thread 01_REPO_MAP.md
@@ -0,0 +1,266 @@
# 01_REPO_MAP.md — NemoClaw
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 | 🟠 Major | ⚡ Quick win

Missing SPDX header in this Markdown source file.

Please add the SPDX copyright/license header before the H1.

As per coding guidelines, "**/*.{js,ts,tsx,jsx,sh,yaml,yml,json,md,mdx}: Every source file must include an SPDX license header for copyright and Apache-2.0 license".

🤖 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 `@01_REPO_MAP.md` at line 1, Add the required SPDX copyright/license header for
Apache-2.0 at the top of the Markdown file before the H1; specifically, open the
file that contains the line "# 01_REPO_MAP.md — NemoClaw" and insert the
standardized SPDX header (copyright notice + SPDX-License-Identifier:
Apache-2.0) as the very first lines above the existing H1.

Comment thread 05_PR_CANDIDATES.md
@@ -0,0 +1,133 @@
# 05_PR_CANDIDATES.md — NemoClaw
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 | 🟠 Major | ⚡ Quick win

Add SPDX license metadata at file start.

05_PR_CANDIDATES.md is missing the required SPDX header.

As per coding guidelines, "**/*.{js,ts,tsx,jsx,sh,yaml,yml,json,md,mdx}: Every source file must include an SPDX license header for copyright and Apache-2.0 license".

🤖 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 `@05_PR_CANDIDATES.md` at line 1, Add the required SPDX license header at the
very top of the file by inserting the SPDX copyright and license lines (e.g.,
include an SPDX-FileCopyrightText line for copyright holder and an
SPDX-License-Identifier: Apache-2.0 line) before the existing content or heading
in 05_PR_CANDIDATES.md so the file complies with the repository rule that every
source/markdown file include an SPDX header.

Comment thread 06_SELECTED_5_PR_PLAN.md
@@ -0,0 +1,232 @@
# 06_SELECTED_5_PR_PLAN.md — NemoClaw
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 | 🟠 Major | ⚡ Quick win

SPDX header is required but absent.

Please prepend the standard SPDX copyright and Apache-2.0 identifier at the top of this file.

As per coding guidelines, "**/*.{js,ts,tsx,jsx,sh,yaml,yml,json,md,mdx}: Every source file must include an SPDX license header for copyright and Apache-2.0 license".

🤖 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 `@06_SELECTED_5_PR_PLAN.md` at line 1, The file 06_SELECTED_5_PR_PLAN.md is
missing the required SPDX license header; prepend a standard SPDX copyright
notice and the "Apache-2.0" SPDX identifier at the very top of
06_SELECTED_5_PR_PLAN.md so the file complies with the repository rule that
every source file (including .md) contains an SPDX header for copyright and
Apache-2.0 licensing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant