[docs] chore: Add docs/tests checklist and refactor PR guidance to CONTRIBUTING.md

[yaoyu-33]

Summary

• All feature PRs: Must evaluate whether documentation and tests need to be added or updated (checklist added to CONTRIBUTING.md)
• Refactoring PRs: Must check docs, docstrings, and scripts under scripts/ for stale references when renaming symbols, moving files, or changing paths
• L1 test trigger: Clarified that PRs labeled needs-more-tests also trigger L1 tests
• New functional tests: Should always start at L0 tier; a maintainer will adjust the tier later if needed

Test plan

• Review rendered CONTRIBUTING.md for formatting correctness
• Documentation-only change — no code or test changes needed

Made with Cursor

Summary by CodeRabbit

• Documentation
  • Updated contribution guidelines with clarified testing tier requirements for pull requests labeled needs-more-tests.
  • Enhanced documentation requirements for new features, including usage examples and architecture descriptions.
  • Added guidance for refactoring pull requests, including mandatory checks for documentation and scripts when renaming or moving public symbols.
  • Improved CI workflow instructions with explicit matrix configuration requirements.

[copy-pr-bot]

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.

[yaoyu-33]

/ok to test b5c2f51

[coderabbitai]

📝 Walkthrough

Walkthrough

CONTRIBUTING.md updated with expanded CI/CD guidance, clarified test tier requirements, enhanced documentation standards for features, and new refactoring procedures guidance. Changes address launcher script setup, PR labeling for tests, and mandatory checks for documentation and refactoring tasks.

Changes

Cohort / File(s)

Summary

Documentation Updates CONTRIBUTING.md

Updated functional tests table (L1 tier trigger now includes PRs labeled needs-more-tests); expanded CI workflow guidance for launcher scripts with explicit matrix integration requirements; renamed "Documentation Requirement" section to include test requirements; added subsections for feature documentation (examples, architecture, internal details), refactoring PRs (checks for renamed/moved public symbols), and enhanced code quality guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: adding a docs/tests checklist and refactoring PR guidance to CONTRIBUTING.md, which aligns with the detailed content changes in the raw summary.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Test Results For Major Changes	✅ Passed	PR contains only documentation changes to CONTRIBUTING.md with no modifications to executable code, test code, or implementation. Documentation-only modifications cannot affect numerics, convergence, or performance.

_{✏️ 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 yuya/contributing-docs-tests-checklist

📝 Coding Plan

• Generate coding plan for human review comments

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

🧹 Nitpick comments (1)

CONTRIBUTING.md (1)

332-339: Consider aligning the example with the L0 guidance.

Line 332 instructs contributors to "always start with the L0 tier," but the YAML example shows an L1 test. For better clarity and consistency, consider either:

1. Updating the example to show an L0 test, or
2. Adding a note explaining that the example shows L1 format but contributors should initially add their script to the L0 matrix

Additionally, "corresponding job matrix" might not be immediately clear to first-time contributors. Consider rephrasing to: "You must also update .github/workflows/cicd-main.yml to include it in the L0 job matrix (or L1/L2 if a maintainer promotes it later):"

📝 Example improvement

-When adding a new launcher script, always start with the **L0** tier so it runs on every PR. A maintainer will adjust the tier later if the test is too slow or better suited for nightly coverage. You must **also update** [`.github/workflows/cicd-main.yml`](.github/workflows/cicd-main.yml) to include it in the corresponding job matrix:
+When adding a new launcher script, always start with the **L0** tier so it runs on every PR. A maintainer will adjust the tier later if the test is too slow or better suited for nightly coverage. You must **also update** [`.github/workflows/cicd-main.yml`](.github/workflows/cicd-main.yml) to include it in the **L0 job matrix** (or L1/L2 if promoted later):

 ```yaml
-# Example: adding an L1 test
-- script: L1_Launch_your_new_test
+# Example: adding an L0 test
+- script: L0_Launch_your_new_test

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against the current code and only fix it if needed.

In @CONTRIBUTING.md around lines 332 - 339, Update the example in
CONTRIBUTING.md to match the guidance to "always start with the L0 tier": change
the shown YAML snippet to use an L0 launcher name (e.g., replace the example
script value with something like L0_Launch_your_new_test) and update the
adjacent sentence to explicitly tell contributors to also add the launcher to
the L0 job matrix in .github/workflows/cicd-main.yml (or note that maintainers
may promote it to L1/L2 later); reference the example YAML block and the file
.github/workflows/cicd-main.yml so reviewers can find and update the snippet and
the explanatory text consistently.

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>🤖 Prompt for all review comments with AI agents</summary>

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @CONTRIBUTING.md:

• Around line 332-339: Update the example in CONTRIBUTING.md to match the
  guidance to "always start with the L0 tier": change the shown YAML snippet to
  use an L0 launcher name (e.g., replace the example script value with something
  like L0_Launch_your_new_test) and update the adjacent sentence to explicitly
  tell contributors to also add the launcher to the L0 job matrix in
  .github/workflows/cicd-main.yml (or note that maintainers may promote it to
  L1/L2 later); reference the example YAML block and the file
  .github/workflows/cicd-main.yml so reviewers can find and update the snippet and
  the explanatory text consistently.

</details>

---

<details>
<summary>ℹ️ Review info</summary>

<details>
<summary>⚙️ Run configuration</summary>

**Configuration used**: Path: .coderabbit.yaml

**Review profile**: CHILL

**Plan**: Pro

**Run ID**: `0f85f6fd-2e7e-4f18-842c-2f120651bad2`

</details>

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 9a4f5312397635536fbb3e0a840078eea876aa40 and b5c2f51fb871a8f1fc0912064a32d8e60bd8288d.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `CONTRIBUTING.md`

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

[yaoyu-33]

/ok to test 597d3b8

[yaoyu-33]

/ok to test a4d7e55