Skip to content

feat(cmake): add comprehensive CMake structure documentation and rules#600

Merged
aristarkhovNV merged 1 commit into
mainfrom
aaristarkhov/cmake-rules
Jun 1, 2026
Merged

feat(cmake): add comprehensive CMake structure documentation and rules#600
aristarkhovNV merged 1 commit into
mainfrom
aaristarkhov/cmake-rules

Conversation

@aristarkhovNV

@aristarkhovNV aristarkhovNV commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator

Fixes #598

Summary by CodeRabbit

  • Documentation

    • Added comprehensive CMake structure conventions documentation serving as the repository's canonical reference.
    • Added CMake structure guidance across multiple contributor tools and instruction files.
  • Chores

    • Updated code review and build configuration to enforce CMake conventions.
    • Updated license configuration for new documentation files.

@aristarkhovNV aristarkhovNV requested review from jiwenc-nv and nvddr June 1, 2026 22:04
@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: e972fd81-440c-41a0-afc8-bddd49ab1295

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR establishes canonical CMake target layout and include path conventions for the IsaacTeleop repository. It introduces a central rules document at cmake/cmake-structure.md that specifies five constraints: one target per leaf directory, no ../ in include/CMake paths, relative "..." for target-owned headers, angle-bracket <...> for external/module headers, and module-name-prefixed public includes via INTERFACE directories. The rules are then distributed across contributor guidance in AGENTS.md, AI tool skill files (Claude, Cursor), GitHub instructions, and CodeRabbit review configuration. License metadata for the new .cursor/ files is added to REUSE.toml to satisfy REUSE compliance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately summarizes the main change: adding comprehensive CMake structure documentation and rules across multiple configuration files and documentation.
Linked Issues check ✅ Passed The PR fully addresses issue #598 by adding comprehensive CMake structure documentation in cmake/cmake-structure.md suitable for AI agent consumption, with supporting configuration files.
Out of Scope Changes check ✅ Passed All changes are directly in scope: documentation, configuration updates, and supporting integration files for CMake/include conventions across tooling and CI/CD.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 aaristarkhov/cmake-rules

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

@aristarkhovNV aristarkhovNV force-pushed the aaristarkhov/cmake-rules branch from b9d8f3f to 041b960 Compare June 1, 2026 23:24
@aristarkhovNV aristarkhovNV merged commit a4c6a70 into main Jun 1, 2026
43 checks passed
@aristarkhovNV aristarkhovNV deleted the aaristarkhov/cmake-rules branch June 1, 2026 23:54
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.

Document our desired header structure in a md file so that AI agent can pick it up

2 participants