agentleFS
NVIDIAKnown publisherNVIDIA/IsaacTeleop/examples/teleop_ros2/AGENTS.md

IsaacTeleop / teleop_ros2

AGENTS.md438 starsChanged 31 days agoApache-2.0View on GitHub

Supported ROS 2 reference publisher for Isaac Teleop. Hosted under examples/ because it depends on ROS 2 and the isaaccapture wheel; it is not part of the core library. Consumed by Isaac ROS Teleop. - In source code files under this package, preserve the existing grouped/sorted organization for helpers, message builders, classes, and member functions: scan the surrounding order before inserting, and do not place helpers near call sites when the existing section is sorted. - In Python integration test…

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this AGENTS.md into the rules it gives an agent

4 rules. About 0 are common, 3 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When creating temporary Docker images for examples/teleop_ros2 validation, remove them before finishing the task unless the user explicitly …

    line 17
  2. Distinctive:

    Keep ROS publisher methods at one abstraction level: call one output-specific pure builder, then publish or broadcast its result.

    line 23
  3. Distinctive:

    Do not extract a one-use mapping helper merely to shorten a builder.

    line 26
  4. Distinctive:

    When renaming a symbol or concept, update semantically coupled type names, fields, variables, constructor keywords, consumers, and tests in …

    line 32

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md
<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. SPDX-License-Identifier: Apache-2.0 -->

Teleop ROS 2 Agent Notes

Supported ROS 2 reference publisher for Isaac Teleop. Hosted under examples/ because it depends on ROS 2 and the isaaccapture wheel; it is not part of the core library. Consumed by Isaac ROS Teleop.

Docker Validation

  • This reference integration needs ROS 2 plus the built isaaccapture wheel, which are not present in the dev container. Run/validate it inside the examples/teleop_ros2/Dockerfile image (the same path CI's test-teleop-ros2 job uses), not directly on the host.
  • To exercise it without live XR hardware, replay an MCAP fixture: build the image, run the installed teleop_ros2_mcap_generator to write a fixture, then run python -m isaaccapture_examples.teleop_ros2 with -p mode:=<mode> -p mcap_replay_path:=<file> and check topics (e.g. via python -m isaaccapture_examples.teleop_ros2.integration_tests.teleop_ros2_topic_verifier). Replay mode does not launch CloudXR, so no GPU/NGC runtime is required. Share the fixture across containers with -v /tmp:/tmp and --network host for ROS 2 discovery.
  • The image build disables some CI gates (-DENABLE_CLANG_FORMAT_CHECK=OFF, -DBUILD_TESTING=OFF), so a green Docker build does not mean C++ formatting or ctest pass. Validate those separately.
  • When creating temporary Docker images for examples/teleop_ros2 validation, remove them before finishing the task unless the user explicitly asks to keep them.

Source Layout

  • In source code files under this package, preserve the existing grouped/sorted organization for helpers, message builders, classes, and member functions: scan the surrounding order before inserting, and do not place helpers near call sites when the existing section is sorted.
  • In Python integration test verifier code, do not use bare assert for runtime validation; Python optimization can disable it, so raise explicit exceptions from validators.
  • Keep ROS publisher methods at one abstraction level: call one output-specific pure builder, then publish or broadcast its result. Compose payload construction and transport encoding inside the message-builder module, not in the node.
  • Do not extract a one-use mapping helper merely to shorten a builder; keep the complete output mapping together unless the helper is reused or represents an independently tested contract.

Rename consistency

  • When renaming a symbol or concept, update semantically coupled type names, fields, variables, constructor keywords, consumers, and tests in the same pass so old and new vocabulary do not coexist.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.