Skip to content

Commit 5f6a825

Browse files
committed
Some rephrasing related to QT/clazy
1 parent ac52803 commit 5f6a825

File tree

5 files changed

+12
-9
lines changed

5 files changed

+12
-9
lines changed

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Baseline shape:
1313
- One small library target plus one CLI target form the default example shape
1414
- Deterministic `CTest`, `clang-tidy`, Doxygen, release-hygiene, and Valgrind
1515
lanes are part of the maintained contract
16-
- Qt/Clazy are optional paths, not baseline assumptions
16+
- Qt/Clazy provide the example UI stack, not the baseline assumption
1717
- Public docs are generated from repo-owned headers and `docs/mainpage.md`
1818
- Feature plans live under `upcoming_features/` as tracked Markdown files only
1919

@@ -71,8 +71,8 @@ Use the smallest validation set that proves the change, then extend as needed:
7171

7272
- `ctest --test-dir "$BUILD_DIR" --output-on-failure`
7373
- `cmake --build "$BUILD_DIR" --target clang-tidy`
74-
- `cmake --build "$BUILD_DIR" --target clazy` for Qt-enabled projects when
75-
available
74+
- `cmake --build "$BUILD_DIR" --target clazy` when the project uses the
75+
example Qt-based UI stack and the tool is available
7676
- `cmake --build "$BUILD_DIR" --target lint`
7777
- `cmake --build "$BUILD_DIR" --target docs`
7878
- `bash scripts/run-valgrind.sh "$BUILD_DIR"`

CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ set(CMAKE_CXX_EXTENSIONS OFF)
1414

1515
option(FRAME_ENABLE_ASAN "Enable AddressSanitizer for repo-owned code" OFF)
1616
option(FRAME_ENABLE_UBSAN "Enable UndefinedBehaviorSanitizer for repo-owned code" OFF)
17-
option(FRAME_ENABLE_QT "Enable optional Qt integration hooks" OFF)
18-
option(FRAME_ENABLE_CLAZY "Enable clazy target when Qt projects need it" OFF)
17+
option(FRAME_ENABLE_QT "Enable the example Qt-based UI integration path" OFF)
18+
option(FRAME_ENABLE_CLAZY "Enable the clazy analyzer lane for the Qt-based UI path" OFF)
1919

2020
find_package(Doxygen QUIET)
2121

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ This frame is designed for projects that want:
1616
- project-local skills under `.agents/skills/`
1717
- CMake-only build and install flow
1818
- deterministic `CTest` coverage with enforced WHAT/HOW/WHY commentary
19-
- `clang-tidy`, optional `clazy`, Doxygen, and Valgrind lanes
19+
- `clang-tidy`, Doxygen, and Valgrind lanes, plus an example Qt/Clazy path for UI projects
2020
- release hygiene and release checklist automation
2121
- generic CI and release GitHub workflows
2222

2323
Defaults:
2424

2525
- portable C++20 library + CLI example
2626
- no Qt requirement by default
27-
- optional Qt/Clazy hooks for projects that need them
27+
- optional Qt/Clazy support as the example stack for projects that add a UI layer
2828
- MIT license
2929

3030
## Quick Start
@@ -71,7 +71,7 @@ upcoming_features/ Forward-looking implementation plans
7171
Optional local tooling:
7272

7373
- `clang-tidy`
74-
- `clazy-standalone` for Qt projects
74+
- `clazy-standalone` when using the example Qt-based UI stack
7575
- `doxygen`
7676
- `valgrind`
7777
- `ninja-build`

RELEASE_CHECKLIST.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ cmake --build "$BUILD_DIR" --target clang-tidy
6363
cmake --build "$BUILD_DIR" --target clazy
6464
```
6565

66+
- Treat `clazy` as part of the Qt-based UI variant rather than a baseline lane
67+
for CLI-only projects.
68+
6669
- If repo-owned public headers or docs changed, also run:
6770

6871
```bash

docs/mainpage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ expectations rather than end-user setup.
1010
- `frame_cli` is the example command-line target
1111
- build, docs, tests, analyzers, and release helpers are first-class repo
1212
concerns
13-
- Qt/Clazy integration is optional rather than baseline
13+
- Qt/Clazy form the example UI stack rather than the baseline project shape
1414
- deterministic tests live under `tests/`
1515
- future plans live under `upcoming_features/`
1616

0 commit comments

Comments
 (0)