Skip to content

Update Cursor rules to use the new naming guidance#1273

Merged
rapids-bot[bot] merged 5 commits intoNVIDIA:release/1.4from
yczhang-nv:yuchen-update-cursor-rules-naming
Dec 17, 2025
Merged

Update Cursor rules to use the new naming guidance#1273
rapids-bot[bot] merged 5 commits intoNVIDIA:release/1.4from
yczhang-nv:yuchen-update-cursor-rules-naming

Conversation

@yczhang-nv
Copy link
Contributor

@yczhang-nv yczhang-nv commented Dec 16, 2025

Description

Updates the terminology sections in Cursor rules to reflect the new naming guidance of NVIDIA NeMo Agent toolkit.

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation

    • Expanded and clarified naming/capitalization guidance for NeMo Agent Toolkit (first‑use vs subsequent references, headings vs body)
    • Prohibited "NAT"/"nat" as a documentation abbreviation; clarified allowed technical identifiers in code contexts
    • Added punctuation guidance and examples (avoid possessive apostrophes for inanimate objects)
    • Removed an outdated LLM model‑selection note from a tutorial
    • Reinforced designated blueprint name and changelog handling guidance
  • Tests

    • Added guideline: do not add pytest.mark.asyncio; async tests are auto-detected
  • Chores

    • Minor formatting adjustments in config/documentation files

✏️ Tip: You can customize this high-level summary in your review settings.

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
@yczhang-nv yczhang-nv self-assigned this Dec 16, 2025
@yczhang-nv yczhang-nv requested a review from a team as a code owner December 16, 2025 19:49
@yczhang-nv yczhang-nv added doc Improvements or additions to documentation non-breaking Non-breaking change labels Dec 16, 2025
@coderabbitai
Copy link

coderabbitai bot commented Dec 16, 2025

Walkthrough

Documentation rules and guidance were updated across Cursor rule files: terminology and naming for the NeMo Agent Toolkit were rewritten (full/short name usage, capitalization, technical identifiers), a prohibition on using NAT/nat in documentation was reinforced, "AIQ Blueprint" naming was fixed, a tutorial note about model Auto mode was removed, and punctuation guidance for inanimate possessives was added.

Changes

Cohort / File(s) Summary
Cursor rules — terminology & capitalization
./.cursor/rules/documentation/capitalization.mdc, ./.cursor/rules/documentation/general.mdc, ./.cursor/rules/general.mdc
Rewrote Terminology/Naming guidance: define full-name vs short-name usage (titles/headers vs body), clarify capitalization differences (e.g., "Toolkit" in headings, "toolkit" in body), enumerate technical identifiers and allowed contexts (nat, nvidia-nat, NAT_, NeMo-Agent-Toolkit), explicitly prohibit NAT/nat in documentation, add fixed "AIQ Blueprint" naming directive, plus minor formatting tweaks.
Cursor rules — punctuation
./.cursor/rules/documentation/punctuation.mdc
Added "inanimate objects" examples under "Don't Use Apostrophes For" (incorrect/correct examples) and a small header markup adjustment.
Tutorial docs
docs/source/get-started/tutorials/build-a-demo-agent-workflow-using-cursor-rules.md
Removed a note admonition that advised against using Auto mode for LLM model selection (deleted the note block).
Tests policy & nat-tests guidance
./.coderabbit.yaml, ./.cursor/rules/nat-tests/general.mdc, ./.cursor/rules/nat-tests/integration-tests.mdc
Added rule to avoid @pytest.mark.asyncio (async tests auto-detected by runner); minor formatting reflow in .coderabbit.yaml.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Focus areas for review:
    • Ensure terminology/capitalization rules are consistent across the three Cursor rules files and examples match guidance.
    • Verify the prohibition of NAT/nat in documentation is clearly scoped and does not conflict with allowed code/env identifiers (e.g., nat, NAT_).
    • Confirm the tutorial note removal did not leave formatting or contextual artifacts.
    • Check the new test guidance lines for clarity and correct placement in nat-tests docs and .coderabbit.yaml.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: updating Cursor rules to incorporate new naming guidance, which is directly reflected across multiple .cursor/rules files in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e460001 and 24b3574.

📒 Files selected for processing (3)
  • .coderabbit.yaml (2 hunks)
  • .cursor/rules/nat-tests/general.mdc (1 hunks)
  • .cursor/rules/nat-tests/integration-tests.mdc (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
.cursor/rules/**/*.mdc

📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)

.cursor/rules/**/*.mdc: Always place rule files in PROJECT_ROOT/.cursor/rules/ directory
Use kebab-case for Cursor rule filenames
Always use .mdc extension for Cursor rule files
Reference the documentation section in main rules instead of directly linking to documentation
Start rule descriptions with 'Follow these rules when' and include specific trigger conditions, relevant action verbs, and comprehensive coverage of relevant scenarios
Never place rule files in the project root or in subdirectories outside .cursor/rules/
Cursor rules must follow a frontmatter structure with description, optional globs pattern, and alwaysApply flag, followed by markdown content with title, step-by-step instructions, code examples, and guidelines

Files:

  • .cursor/rules/nat-tests/integration-tests.mdc
  • .cursor/rules/nat-tests/general.mdc
.cursor/rules/**/general.mdc

📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)

.cursor/rules/**/general.mdc: Always include a general.mdc file with overarching guidelines when creating topic subdirectories in .cursor/rules/
Include a Referenced Documentation section in general.mdc files that lists all documentation referenced in the rules with descriptive names and brief descriptions

Files:

  • .cursor/rules/nat-tests/general.mdc
🧠 Learnings (18)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Start rule descriptions with 'Follow these rules when' and include specific trigger conditions, relevant action verbs, and comprehensive coverage of relevant scenarios
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Cursor rules must follow a frontmatter structure with description, optional globs pattern, and alwaysApply flag, followed by markdown content with title, step-by-step instructions, code examples, and guidelines
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Use kebab-case for Cursor rule filenames
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Reference the documentation section in main rules instead of directly linking to documentation
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst} : Use 'NeMo Agent Toolkit' (capitalize 'T') when the name appears in headings
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to docs/**/*.{md,rst} : Never use deprecated names: Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq in documentation (unless intentionally referring to deprecated versions)
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst,py} : Use 'NVIDIA NeMo Agent toolkit' on first use, then 'NeMo Agent toolkit' for subsequent references
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/general.mdc : Include a Referenced Documentation section in general.mdc files that lists all documentation referenced in the rules with descriptive names and brief descriptions
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/general.mdc : Always include a general.mdc file with overarching guidelines when creating topic subdirectories in .cursor/rules/
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Always use .mdc extension for Cursor rule files
📚 Learning: 2025-11-14T20:33:53.944Z
Learnt from: AnuradhaKaruppiah
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 1181
File: packages/nvidia_nat_test/tests/test_test_llm.py:419-484
Timestamp: 2025-11-14T20:33:53.944Z
Learning: The NVIDIA NeMo-Agent-Toolkit project uses pytest-asyncio in strict mode (the default), which requires pytest.mark.asyncio decorator on all async test functions. All async tests in packages/nvidia_nat_test/tests/test_test_llm.py consistently follow this pattern.

Applied to files:

  • .cursor/rules/nat-tests/integration-tests.mdc
  • .cursor/rules/nat-tests/general.mdc
  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/test_*.py : Use pytest with pytest-asyncio for asynchronous code testing

Applied to files:

  • .cursor/rules/nat-tests/integration-tests.mdc
  • .cursor/rules/nat-tests/general.mdc
  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/test_*.py : Mark integration tests requiring external services with pytest.mark.integration so they can be skipped in the default test suite

Applied to files:

  • .cursor/rules/nat-tests/integration-tests.mdc
  • .cursor/rules/nat-tests/general.mdc
  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Unit tests live in tests/ (or examples/*/tests) and use markers defined in pyproject.toml (e.g. integration)

Applied to files:

  • .cursor/rules/nat-tests/integration-tests.mdc
  • .cursor/rules/nat-tests/general.mdc
  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/test_*.py : Mock external services with pytest_httpserver or unittest.mock instead of hitting live endpoints

Applied to files:

  • .cursor/rules/nat-tests/integration-tests.mdc
  • .cursor/rules/nat-tests/general.mdc
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/test_*.py : Mark slow tests with pytest.mark.slow so they can be skipped in the default test suite

Applied to files:

  • .cursor/rules/nat-tests/integration-tests.mdc
  • .cursor/rules/nat-tests/general.mdc
  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/test_*.py : Extract frequently repeated code into pytest fixtures, which should be named using the fixture_ prefix and define the name argument in the decorator

Applied to files:

  • .cursor/rules/nat-tests/integration-tests.mdc
  • .cursor/rules/nat-tests/general.mdc
  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Maintain ≥ 80% test coverage; add or update tests when introducing changes

Applied to files:

  • .cursor/rules/nat-tests/general.mdc
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to packages/*/pyproject.toml : The pyproject.toml should declare a dependency on nvidia-nat or another package with a name starting with nvidia-nat-

Applied to files:

  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{py,toml,yaml,yml} : Use abbreviations: 'nat' for API namespace and CLI tool, 'nvidia-nat' for package name, 'NAT' for environment variable prefixes and informal comments

Applied to files:

  • .coderabbit.yaml
📚 Learning: 2025-11-10T21:26:35.059Z
Learnt from: jiaxiangr
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 974
File: packages/nvidia_nat_all/pyproject.toml:39-39
Timestamp: 2025-11-10T21:26:35.059Z
Learning: In packages/nvidia_nat_all/pyproject.toml, workspace dependencies (nvidia-nat-* plugin packages) should NOT have version constraints because they are managed as workspace dependencies. Version constraints are only applied to the base nvidia-nat package and external dependencies, not to internal workspace packages.

Applied to files:

  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Packages containing Python code should have tests in a tests/ directory at the same level as pyproject.toml

Applied to files:

  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Each package should contain a pyproject.toml file

Applied to files:

  • .coderabbit.yaml
📚 Learning: 2025-12-03T18:42:23.494Z
Learnt from: AnuradhaKaruppiah
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 1147
File: packages/nvidia_nat_a2a/pyproject.toml:1-10
Timestamp: 2025-12-03T18:42:23.494Z
Learning: In the packages/ directory, pyproject.toml files typically do not include SPDX license headers. Out of 34 packages, only nvidia_nat_strands is an exception. This pattern differs from the requirement for SPDX headers in source code files (.py, .js, .ts, etc.).

Applied to files:

  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Name test files test_*.py and store them alongside the code in a tests/ folder

Applied to files:

  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Python code in examples should be placed in a src/ subdirectory with a pyproject.toml file

Applied to files:

  • .coderabbit.yaml
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/pyproject.toml : Dependencies should use ~=<version> format with two-digit versions (e.g., ~=1.0)

Applied to files:

  • .coderabbit.yaml
🔇 Additional comments (4)
.cursor/rules/nat-tests/general.mdc (1)

29-29: Guideline is consistent with integration test rules.

This guideline aligns with the corresponding change in integration-tests.mdc. The policy change is consistently applied across both unit and integration test guidelines.

Note: This is part of the same pytest configuration change that should be verified (see comment on integration-tests.mdc).

.coderabbit.yaml (2)

132-133: LGTM - Line reformatted for readability.

The sentence has been reflowed onto a single line without changing its meaning.


145-146: Test policy consistently updated across configuration.

This guideline aligns with the changes in the Cursor rules files and includes helpful context about why the decorator is unnecessary. The policy change is consistently applied across all configuration files.

Note: This is part of the same pytest configuration change that should be verified (see comment on integration-tests.mdc).

.cursor/rules/nat-tests/integration-tests.mdc (1)

178-178: The pytest configuration is correctly set to asyncio_mode = "auto" in pyproject.toml, which enables automatic async test detection. The guideline is accurate and does not require changes.


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

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

@yczhang-nv yczhang-nv changed the base branch from develop to release/1.4 December 16, 2025 20:30
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Copy link

@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: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b8759ee and e1870c5.

📒 Files selected for processing (1)
  • .cursor/rules/documentation/punctuation.mdc (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
.cursor/rules/**/*.mdc

📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)

.cursor/rules/**/*.mdc: Always place rule files in PROJECT_ROOT/.cursor/rules/ directory
Use kebab-case for Cursor rule filenames
Always use .mdc extension for Cursor rule files
Reference the documentation section in main rules instead of directly linking to documentation
Start rule descriptions with 'Follow these rules when' and include specific trigger conditions, relevant action verbs, and comprehensive coverage of relevant scenarios
Never place rule files in the project root or in subdirectories outside .cursor/rules/
Cursor rules must follow a frontmatter structure with description, optional globs pattern, and alwaysApply flag, followed by markdown content with title, step-by-step instructions, code examples, and guidelines

Files:

  • .cursor/rules/documentation/punctuation.mdc
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Start rule descriptions with 'Follow these rules when' and include specific trigger conditions, relevant action verbs, and comprehensive coverage of relevant scenarios
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Cursor rules must follow a frontmatter structure with description, optional globs pattern, and alwaysApply flag, followed by markdown content with title, step-by-step instructions, code examples, and guidelines
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Use kebab-case for Cursor rule filenames
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Reference the documentation section in main rules instead of directly linking to documentation
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst} : Use 'NeMo Agent Toolkit' (capitalize 'T') when the name appears in headings
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to docs/**/*.{md,rst} : Never use deprecated names: Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq in documentation (unless intentionally referring to deprecated versions)
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst,py} : Use 'NVIDIA NeMo Agent toolkit' on first use, then 'NeMo Agent toolkit' for subsequent references
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{py,toml,yaml,yml} : Use abbreviations: 'nat' for API namespace and CLI tool, 'nvidia-nat' for package name, 'NAT' for environment variable prefixes and informal comments
Learnt from: zterek
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 1243
File: examples/risk_and_security/retail_agent/src/nat_retail_agent/configs/red-teaming.yml:1-98
Timestamp: 2025-12-12T20:49:51.370Z
Learning: In the NVIDIA/NeMo-Agent-Toolkit repository, most YAML configuration files use 2-space indentation rather than 4-space indentation. When reviewing YAML files, prefer consistency with the existing codebase style (2-space indentation) over the stated coding guideline (4-space indentation) until a repository-wide standardization is performed.
Learnt from: AnuradhaKaruppiah
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 701
File: examples/evaluation_and_profiling/simple_calculator_eval/src/nat_simple_calculator_eval/configs/config-with-custom-post-process.yml:16-18
Timestamp: 2025-08-22T20:29:13.433Z
Learning: In the NeMo-Agent-Toolkit project, configuration consistency across example files is prioritized over removing unused config options, even when those options aren't currently implemented in the runtime.
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst} : Use 'NeMo Agent Toolkit' (capitalize 'T') when the name appears in headings

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst,py} : Use 'NVIDIA NeMo Agent toolkit' on first use, then 'NeMo Agent toolkit' for subsequent references

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: CI Pipeline / Check

@yczhang-nv yczhang-nv requested a review from lvojtku December 16, 2025 21:15
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Copy link

@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: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e1870c5 and e460001.

📒 Files selected for processing (1)
  • .cursor/rules/documentation/punctuation.mdc (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
.cursor/rules/**/*.mdc

📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)

.cursor/rules/**/*.mdc: Always place rule files in PROJECT_ROOT/.cursor/rules/ directory
Use kebab-case for Cursor rule filenames
Always use .mdc extension for Cursor rule files
Reference the documentation section in main rules instead of directly linking to documentation
Start rule descriptions with 'Follow these rules when' and include specific trigger conditions, relevant action verbs, and comprehensive coverage of relevant scenarios
Never place rule files in the project root or in subdirectories outside .cursor/rules/
Cursor rules must follow a frontmatter structure with description, optional globs pattern, and alwaysApply flag, followed by markdown content with title, step-by-step instructions, code examples, and guidelines

Files:

  • .cursor/rules/documentation/punctuation.mdc
🧠 Learnings (10)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Start rule descriptions with 'Follow these rules when' and include specific trigger conditions, relevant action verbs, and comprehensive coverage of relevant scenarios
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Cursor rules must follow a frontmatter structure with description, optional globs pattern, and alwaysApply flag, followed by markdown content with title, step-by-step instructions, code examples, and guidelines
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Use kebab-case for Cursor rule filenames
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Reference the documentation section in main rules instead of directly linking to documentation
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst} : Use 'NeMo Agent Toolkit' (capitalize 'T') when the name appears in headings
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to docs/**/*.{md,rst} : Never use deprecated names: Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq in documentation (unless intentionally referring to deprecated versions)
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst,py} : Use 'NVIDIA NeMo Agent toolkit' on first use, then 'NeMo Agent toolkit' for subsequent references
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{py,toml,yaml,yml} : Use abbreviations: 'nat' for API namespace and CLI tool, 'nvidia-nat' for package name, 'NAT' for environment variable prefixes and informal comments
Learnt from: zterek
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 1243
File: examples/risk_and_security/retail_agent/src/nat_retail_agent/configs/red-teaming.yml:1-98
Timestamp: 2025-12-12T20:49:51.370Z
Learning: In the NVIDIA/NeMo-Agent-Toolkit repository, most YAML configuration files use 2-space indentation rather than 4-space indentation. When reviewing YAML files, prefer consistency with the existing codebase style (2-space indentation) over the stated coding guideline (4-space indentation) until a repository-wide standardization is performed.
Learnt from: AnuradhaKaruppiah
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 701
File: examples/evaluation_and_profiling/simple_calculator_eval/src/nat_simple_calculator_eval/configs/config-with-custom-post-process.yml:16-18
Timestamp: 2025-08-22T20:29:13.433Z
Learning: In the NeMo-Agent-Toolkit project, configuration consistency across example files is prioritized over removing unused config options, even when those options aren't currently implemented in the runtime.
📚 Learning: 2025-11-24T18:56:07.172Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Start rule descriptions with 'Follow these rules when' and include specific trigger conditions, relevant action verbs, and comprehensive coverage of relevant scenarios

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst} : Use 'NeMo Agent Toolkit' (capitalize 'T') when the name appears in headings

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{md,rst,py} : Use 'NVIDIA NeMo Agent toolkit' on first use, then 'NeMo Agent toolkit' for subsequent references

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to docs/**/*.{md,rst} : Never use deprecated names: Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq in documentation (unless intentionally referring to deprecated versions)

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
📚 Learning: 2025-11-24T18:56:53.109Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-11-24T18:56:53.109Z
Learning: Applies to **/*.{py,toml,yaml,yml} : Use abbreviations: 'nat' for API namespace and CLI tool, 'nvidia-nat' for package name, 'NAT' for environment variable prefixes and informal comments

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
📚 Learning: 2025-11-24T18:56:07.172Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Use kebab-case for Cursor rule filenames

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
📚 Learning: 2025-12-12T20:49:51.370Z
Learnt from: zterek
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 1243
File: examples/risk_and_security/retail_agent/src/nat_retail_agent/configs/red-teaming.yml:1-98
Timestamp: 2025-12-12T20:49:51.370Z
Learning: In the NVIDIA/NeMo-Agent-Toolkit repository, most YAML configuration files use 2-space indentation rather than 4-space indentation. When reviewing YAML files, prefer consistency with the existing codebase style (2-space indentation) over the stated coding guideline (4-space indentation) until a repository-wide standardization is performed.

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
📚 Learning: 2025-08-22T20:29:13.433Z
Learnt from: AnuradhaKaruppiah
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 701
File: examples/evaluation_and_profiling/simple_calculator_eval/src/nat_simple_calculator_eval/configs/config-with-custom-post-process.yml:16-18
Timestamp: 2025-08-22T20:29:13.433Z
Learning: In the NeMo-Agent-Toolkit project, configuration consistency across example files is prioritized over removing unused config options, even when those options aren't currently implemented in the runtime.

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
📚 Learning: 2025-11-24T18:56:07.172Z
Learnt from: CR
Repo: NVIDIA/NeMo-Agent-Toolkit PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-11-24T18:56:07.172Z
Learning: Applies to .cursor/rules/**/*.mdc : Cursor rules must follow a frontmatter structure with description, optional globs pattern, and alwaysApply flag, followed by markdown content with title, step-by-step instructions, code examples, and guidelines

Applied to files:

  • .cursor/rules/documentation/punctuation.mdc
🔇 Additional comments (2)
.cursor/rules/documentation/punctuation.mdc (2)

35-38: Product naming in examples is correct and consistent.

The examples correctly use "NeMo Agent toolkit" with lowercase 't' for subsequent mentions in documentation, consistent with the naming guidance: "Use 'NVIDIA NeMo Agent toolkit' on first use, then 'NeMo Agent toolkit' for subsequent references." The past review feedback about product name capitalization has been properly addressed. The subsection provides clear guidance with practical examples showing incorrect and correct possessive phrasing for inanimate objects.


128-131: Minor formatting adjustment in quotation marks section.

The header and content at Lines 128–131 follow the established formatting pattern and clearly distinguish between when question marks/exclamation points go inside vs. outside quotation marks. The guidance is accurate and complete.

Copy link
Contributor

@mnajafian-nv mnajafian-nv left a comment

Choose a reason for hiding this comment

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

Looks great to me 👍

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
@mnajafian-nv
Copy link
Contributor

Please mark open PRs as Draft if they are not ready for review :)

@yczhang-nv
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 1b9965b into NVIDIA:release/1.4 Dec 17, 2025
26 of 28 checks passed
yczhang-nv added a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request Dec 22, 2025
Updates the terminology sections in Cursor rules to reflect the new naming guidance of NVIDIA NeMo Agent toolkit.

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

## Summary by CodeRabbit

* **Documentation**
  * Expanded and clarified naming/capitalization guidance for NeMo Agent Toolkit (first‑use vs subsequent references, headings vs body)
  * Prohibited "NAT"/"nat" as a documentation abbreviation; clarified allowed technical identifiers in code contexts
  * Added punctuation guidance and examples (avoid possessive apostrophes for inanimate objects)
  * Removed an outdated LLM model‑selection note from a tutorial
  * Reinforced designated blueprint name and changelog handling guidance

* **Tests**
  * Added guideline: do not add pytest.mark.asyncio; async tests are auto-detected

* **Chores**
  * Minor formatting adjustments in config/documentation files

<sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub>

Authors:
  - Yuchen Zhang (https://github.com/yczhang-nv)

Approvers:
  - https://github.com/mnajafian-nv

URL: NVIDIA#1273
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
yczhang-nv added a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request Dec 22, 2025
Updates the terminology sections in Cursor rules to reflect the new naming guidance of NVIDIA NeMo Agent toolkit.

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

## Summary by CodeRabbit

* **Documentation**
  * Expanded and clarified naming/capitalization guidance for NeMo Agent Toolkit (first‑use vs subsequent references, headings vs body)
  * Prohibited "NAT"/"nat" as a documentation abbreviation; clarified allowed technical identifiers in code contexts
  * Added punctuation guidance and examples (avoid possessive apostrophes for inanimate objects)
  * Removed an outdated LLM model‑selection note from a tutorial
  * Reinforced designated blueprint name and changelog handling guidance

* **Tests**
  * Added guideline: do not add pytest.mark.asyncio; async tests are auto-detected

* **Chores**
  * Minor formatting adjustments in config/documentation files

<sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub>

Authors:
  - Yuchen Zhang (https://github.com/yczhang-nv)

Approvers:
  - https://github.com/mnajafian-nv

URL: NVIDIA#1273
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
@yczhang-nv yczhang-nv deleted the yuchen-update-cursor-rules-naming branch December 24, 2025 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants