Skip to content

Commit 6aaef0c

Browse files
nhortonclaude
andauthored
Doc updates for compare_to (#79)
* Make compare_to field required in rules format Previously compare_to was optional with a default of "base". Now it must be explicitly specified in all rule definitions, making the change detection baseline configuration explicit rather than implicit. Changes: - Update schema to require compare_to field - Remove default value from rules parser - Update documentation to reflect required status - Add test for missing compare_to validation - Update all test rule definitions to include compare_to * Add compare_to field to all existing rule files All rule files now require the compare_to field. Updated: - .deepwork/rules/architecture-documentation-accuracy.md - .deepwork/rules/readme-accuracy.md - .deepwork/rules/standard-jobs-source-of-truth.md - .deepwork/rules/version-and-changelog-update.md - src/deepwork/standard_jobs/deepwork_rules/rules/skill-md-validation.md Also ran deepwork install to sync changes. * Update documentation to show compare_to as required All rule examples in doc/architecture.md and README.md now include the compare_to field to reflect that it is now required. --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent d615a22 commit 6aaef0c

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,7 @@ name: Source/Test Pairing
262262
set:
263263
- src/{path}.py
264264
- tests/{path}_test.py
265+
compare_to: base
265266
---
266267
When source files change, corresponding test files should also change.
267268
Please create or update tests for the modified source files.
@@ -275,6 +276,7 @@ trigger: "**/*.py"
275276
action:
276277
command: "ruff format {file}"
277278
run_for: each_match
279+
compare_to: prompt
278280
---
279281
```
280282

doc/architecture.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1028,6 +1028,7 @@ name: Source/Test Pairing
10281028
set:
10291029
- src/{path}.py
10301030
- tests/{path}_test.py
1031+
compare_to: base
10311032
---
10321033
When source files change, corresponding test files should also change.
10331034
Please create or update tests for the modified source files.
@@ -1043,6 +1044,7 @@ Rules support three detection modes:
10431044
name: Update install guide
10441045
trigger: "app/config/**/*"
10451046
safety: "docs/install_guide.md"
1047+
compare_to: base
10461048
---
10471049
```
10481050

@@ -1053,6 +1055,7 @@ name: Source/Test Pairing
10531055
set:
10541056
- src/{path}.py
10551057
- tests/{path}_test.py
1058+
compare_to: base
10561059
---
10571060
```
10581061
Uses variable patterns like `{path}` (multi-segment) and `{name}` (single-segment) for matching.
@@ -1064,6 +1067,7 @@ name: API Documentation
10641067
pair:
10651068
trigger: src/api/{name}.py
10661069
expects: docs/api/{name}.md
1070+
compare_to: base
10671071
---
10681072
```
10691073

@@ -1074,6 +1078,7 @@ pair:
10741078
---
10751079
name: Security Review
10761080
trigger: "src/auth/**/*"
1081+
compare_to: base
10771082
---
10781083
Please check for hardcoded credentials and validate input.
10791084
```
@@ -1086,6 +1091,7 @@ trigger: "**/*.py"
10861091
action:
10871092
command: "ruff format {file}"
10881093
run_for: each_match # or "all_matches"
1094+
compare_to: prompt
10891095
---
10901096
```
10911097

0 commit comments

Comments
 (0)