Skip to content

AGENTS.md

Latest commit

 

History

History
47 lines (39 loc) · 3.25 KB

AGENTS.md

File metadata and controls

47 lines (39 loc) · 3.25 KB

ITK AI Agent Guide

The Insight Toolkit (ITK) is a cross-platform, open-source C++ toolkit for N-dimensional scientific image processing, segmentation, and registration. Apache 2.0 licensed. Build tool: Pixi (wraps CMake + Ninja).

Context to Load on Demand

Load only what your task requires. Files are small and focused — load the minimum set for the task at hand.

Task Read
Writing ANY committed text (in-source comment, commit message, PR body) prose-budget.md
Understanding the codebase layout architecture.md
Building or configuring ITK building.md
Writing or running tests testing.md
Code style, formatting, naming enforced-code-style.md
Writing or reviewing C++ code code-review-lessons.md
Writing ITK C++ classes, CMake, Python wrapping conventions.md
Avoiding compiler pitfalls and refactoring hazards compiler-cautions.md
Creating a DOC: commit git-commits.md
Creating a STYLE: commit git-commits.md, enforced-code-style.md
Creating a BUG: or ENH: commit git-commits.md, compiler-cautions.md, testing.md
Creating a COMP: commit git-commits.md, compiler-cautions.md
Commit or PR attribution attribution.md
Opening or updating a pull request pull-requests.md, attribution.md

Critical Pitfalls

  1. Template errors are verbose — focus on the first error only.
  2. Python wrapping is incomplete — check wrapping/ dirs for available types before assuming a class is wrapped.
  3. Never delete ITK objects — always use SmartPointer (auto filter = FilterType::New()).
  4. Update() is required — filters don't execute until called; parameter changes after Update() need another call.
  5. Link errors → check itk-module.cmake — missing DEPENDS or PRIVATE_DEPENDS is the usual cause.
  6. Licensing — verify AI output does not reproduce third-party code in conflict with Apache 2.0.
  7. Verbose committed text is a review-blocking defect — not a stylistic preference. Reviewers reject PRs whose commit messages, in-source comments, or PR bodies exceed the budgets in prose-budget.md. Cut prose, not code.

Resources