Skip to content

Commit d19f7a0

Browse files
committed
DOC: Address thewtex review comments in AGENTS.md and testing.md
- AGENTS.md: Use 'The Insight Toolkit (ITK)' (full name first) - AGENTS.md: Rename section to 'Context to Load on Demand' - AGENTS.md: Expand conventions.md row to 'Writing ITK C++ classes, CMake build configuration, and Python wrapping configuration' - AGENTS.md: Add ./ prefix and Markdown links to all context file paths - testing.md: Prefix all ctest commands with 'pixi run --as-is' so they succeed on systems without system-level ctest in PATH
1 parent 3b246a0 commit d19f7a0

2 files changed

Lines changed: 17 additions & 21 deletions

File tree

AGENTS.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# ITK AI Agent Guide
22

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

7-
## Context on Demand
7+
## Context to Load on Demand
88

99
Load only what your task requires:
1010

1111
| Task | Read |
1212
|------|------|
13-
| Understanding the codebase layout | `Documentation/AI/architecture.md` |
14-
| Building or configuring ITK | `Documentation/AI/building.md` |
15-
| Writing or running tests | `Documentation/AI/testing.md` |
16-
| Code style, naming conventions | `Documentation/AI/style.md` |
17-
| Writing ITK C++ or Python | `Documentation/AI/conventions.md` |
18-
| Creating a git commit | `Documentation/AI/git-commits.md` |
19-
| Opening or updating a pull request | `Documentation/AI/pull-requests.md` |
13+
| Understanding the codebase layout | [./Documentation/AI/architecture.md](./Documentation/AI/architecture.md) |
14+
| Building or configuring ITK | [./Documentation/AI/building.md](./Documentation/AI/building.md) |
15+
| Writing or running tests | [./Documentation/AI/testing.md](./Documentation/AI/testing.md) |
16+
| Code style, naming conventions | [./Documentation/AI/style.md](./Documentation/AI/style.md) |
17+
| Writing ITK C++ classes, CMake build configuration, and Python wrapping configuration | [./Documentation/AI/conventions.md](./Documentation/AI/conventions.md) |
18+
| Creating a git commit | [./Documentation/AI/git-commits.md](./Documentation/AI/git-commits.md) |
19+
| Opening or updating a pull request | [./Documentation/AI/pull-requests.md](./Documentation/AI/pull-requests.md) |
2020

2121
## Critical Pitfalls
2222

Documentation/AI/testing.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,15 @@
22

33
## Running Tests
44

5+
Via Pixi (recommended — works even without system-level cmake/ctest):
56
```bash
6-
cd build
7-
ctest -j8 # All tests in parallel
8-
ctest -R ImageFilter # Tests matching regex
9-
ctest -L REQUIRES_GPU # Tests with label
10-
ctest --rerun-failed # Only previously failed tests
11-
ctest -L ITKCommon # Tests for a specific module
12-
```
13-
14-
Via Pixi (recommended):
15-
```bash
16-
pixi run --as-is test # C++ tests
17-
pixi run --as-is test-python # Python tests
7+
pixi run --as-is test # All C++ tests
8+
pixi run --as-is test-python # Python tests
9+
pixi run --as-is ctest -j8 # All tests in parallel
10+
pixi run --as-is ctest -R ImageFilter # Tests matching regex
11+
pixi run --as-is ctest -L REQUIRES_GPU # Tests with label
12+
pixi run --as-is ctest --rerun-failed # Only previously failed tests
13+
pixi run --as-is ctest -L ITKCommon # Tests for a specific module
1814
```
1915

2016
## Test Organization

0 commit comments

Comments
 (0)