Update Cursor rules to use the new naming guidance#1273
Update Cursor rules to use the new naming guidance#1273rapids-bot[bot] merged 5 commits intoNVIDIA:release/1.4from
Conversation
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
WalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
🧰 Additional context used📓 Path-based instructions (2).cursor/rules/**/*.mdc📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)
Files:
.cursor/rules/**/general.mdc📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)
Files:
🧠 Learnings (18)📓 Common learnings📚 Learning: 2025-11-14T20:33:53.944ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-10T21:26:35.059ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-12-03T18:42:23.494ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
📚 Learning: 2025-11-24T18:56:53.109ZApplied to files:
🔇 Additional comments (4)
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. Comment |
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 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
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 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.
mnajafian-nv
left a comment
There was a problem hiding this comment.
Looks great to me 👍
Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>
|
Please mark open PRs as Draft if they are not ready for review :) |
|
/merge |
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>
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>
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:
Summary by CodeRabbit
Documentation
Tests
Chores
✏️ Tip: You can customize this high-level summary in your review settings.