docs(#6160): extract harness field reference into living doc - #6398
Conversation
The harness-composition.md checklist (steps 1-5) covered merge function updates but did not include maintaining field classification tables when a field's forge-level status changed. This caused a HIGH review finding on PR #6139 where ADR-0045's tables contradicted the code change. Per maintainer direction, instead of adding a step that points to the frozen ADR, create a living reference document (docs/contributing/harness-fields.md) that extracts the evolving field classifications, merge rules, and ForgeConfig struct from ADR-0045 and overlay rules from ADR-0088. Changes: - Create docs/contributing/harness-fields.md as the authoritative living reference for field classifications and merge rules - Add step 6 to harness-composition.md checklist pointing to the living doc - Mark ADR-0045 as Superseded by ADR-0088 with cross-reference to the living doc - Add cross-reference note to ADR-0088 pointing to the living doc - Update docs/architecture.md to note ADR-0045 supersession and link to the living doc - Add harness-fields.md to AGENTS.md topic-specific guidance table Note: pre-commit could not run (sandbox network policy blocks git fetch for hook environment setup). The post-script runs pre-commit authoritatively on the runner. Closes #6160
|
🤖 Finished Review · ✅ Success · Started 8:41 PM UTC · Completed 8:56 PM UTC Commit: |
Site previewPreview: https://d3241735-site.fullsend-ai.workers.dev Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Low
Previous runReviewFindingsHigh
Medium
Low
Next steps:
|
|
🤖 Finished Fix · ✅ Success · Started 8:58 PM UTC · Completed 9:06 PM UTC Commit: |
- Add missing `Env *EnvConfig` field to ForgeConfig struct definition, both-levels classification table, and merge rules table - Add missing top-level-only fields: doc, effort, readonly_repo, allow_runtime_fetch, max_runtime_fetches, trigger - Mark overlay resolution section as planned/future (ADR-0088 not yet implemented); add current resolution pipeline section - Mark overlays merge rule row as planned - Remove superseded_by frontmatter key from ADR-0045 to match existing convention (other superseded ADRs use only status field) - Update stale ADR-0045 reference in SKILL.md to point to living doc - Clarify skills merge description wording Addresses review feedback on #6398
🔧 Fix agent — iteration 1 (bot-triggered)Addressed all 8 review findings. Fixed 7 (missing env field in struct/tables, incomplete field classification, overlay section presented as current, missing env merge rule, frontmatter inconsistency, stale ADR reference in SKILL.md, misleading skills merge wording). Disagreed with 1 (protected-path AGENTS.md — informational finding about human approval requirement, not a code change request). Fixed (7):
Disagreed (1):
Tests: passedNext steps:
|
|
🤖 Finished Review · ✅ Success · Started 9:08 PM UTC · Completed 9:24 PM UTC Commit: |
Superseded by updated review
|
🤖 Finished Retro · ✅ Success · Started 5:24 PM UTC · Completed 5:39 PM UTC Commit: |
Retro: PR #6398 — extract harness field reference into living docTimelineThis PR has a two-act history. Issue #6160 was auto-generated by the retro agent. On Aug 12, the code agent produced PR #6161, which added a checklist step directing agents to update ADR-0045 in place. The review agent approved it with a blanket "Looks good to me" (zero inline comments) and the PR was auto-labeled The system correctly re-triaged issue #6160, incorporating Ralph's feedback. On Aug 19, the code agent produced PR #6398 with the correct approach: a new PR #6398 workflow qualityThe PR #6398 pipeline performed well:
Agent review coverage was a strict superset of human review on PR #6398. Evidence for existing issues
Proposals filed
|
Summary
Extract evolving harness field classification tables, merge rules, and
ForgeConfigstruct definition from ADR-0045 and ADR-0088 into a new living reference document (docs/contributing/harness-fields.md). Add step 6 to the harness-composition.md checklist directing developers to update this document when adding or modifying harness fields. Mark ADR-0045 as Superseded by ADR-0088.Changes
docs/contributing/harness-fields.md— authoritative living reference for field classifications (both-level vs top-level-only), merge/inheritance rules,ForgeConfigstruct, and overlay resolution pipelinedocs/contributing/harness-composition.md— add step 6 to the checklist pointing to the living doc; update step 1 cross-reference from ADR-0045 to the living doc; add living doc and ADR-0088 to Related sectiondocs/ADRs/0045-forge-portable-harness-schema.md— change status to Superseded by ADR-0088; add cross-reference note to living docdocs/ADRs/0088-cel-guarded-overlays.md— add cross-reference note to living docdocs/architecture.md— update ADR-0045 reference to note supersession and link to living docAGENTS.md— add harness-fields.md to topic-specific guidance tableTesting
gitlint --commit HEADpassesCloses #6160
Post-script verification
agent/6160-harness-fields-living-doc)4c61f4ca8850b08d5685213923abafd6ece2d84a..HEAD)