Doc updates and validation for the no-code-change comment feature #311

New issue

david · 2026-09-05T18:36:22Z

david commented

2026-09-05 18:36:22 +00:00

Summary

Update the project docs — the AGENTS.md error-handling table + ADR cross-references and the DESIGN.md §3.4 artifact inventory — for the new fatal, resumable no-code-change comment path, then run the full validation sequence (lint, unit tests, build, gated E2E) (ADR-021 §5 + §9).

Background

Depends on: #310

ADR-021 (docs/adr/021-no-code-change-comment.md) is already written as the feature's design record — no changes to it (read it to keep wording consistent). The doc work makes the new behavior load-bearing-documented: the error-handling policy table in AGENTS.md must gain the fatal write-back-attributed row, and DESIGN.md must list the new artifact. The validation sequence is the feature's final gate.

Implementation Details

AGENTS.md — error-handling policy table: add the fatal row (no-code-change comment failure → abort with error.json, resumable — an explicit exception to the non-fatal write-back row, per ADR-021 §5). Add the ADR-021 cross-reference to the ADR list paragraph.
DESIGN.md — §3.4 artifact inventory: add no-code-change-comment.json ({ issueKey, postedAt }) with a note on the resume special case (valid no-code-change.json = implement-complete evidence → resume skips implement).
docs/adr/021-no-code-change-comment.md — already exists; leave untouched.
Validation: npm run lint, npm test (all unit suites incl. the new ones), npm run build, then the gated resume E2E (PILOOP_E2E=1) plus one real no-code-change run against a sandbox issue to eyeball the posted comment text.

Acceptance Criteria

AGENTS.md contains the fatal error-policy row (no-code-change comment failure → abort, error.json, resumable) and the ADR-021 cross-reference in the ADR list.
DESIGN.md §3.4 documents no-code-change-comment.json with its { issueKey, postedAt } shape and the resume special case.
npm run lint, npm test, and npm run build all green.
Gated resume E2E passes per the E2E issue; one real no-code-change run posts a legible comment.

Test Plan

The validation sequence above IS the test plan — report results per command.

## Summary Update the project docs — the AGENTS.md error-handling table + ADR cross-references and the DESIGN.md §3.4 artifact inventory — for the new fatal, resumable no-code-change comment path, then run the full validation sequence (lint, unit tests, build, gated E2E) (ADR-021 §5 + §9). ## Background **Depends on:** #310 ADR-021 (`docs/adr/021-no-code-change-comment.md`) is already written as the feature's design record — no changes to it (read it to keep wording consistent). The doc work makes the new behavior load-bearing-documented: the error-handling policy table in AGENTS.md must gain the fatal write-back-attributed row, and DESIGN.md must list the new artifact. The validation sequence is the feature's final gate. ## Implementation Details - `AGENTS.md` — error-handling policy table: add the fatal row (no-code-change comment failure → abort with `error.json`, resumable — an explicit exception to the non-fatal write-back row, per ADR-021 §5). Add the ADR-021 cross-reference to the ADR list paragraph. - `DESIGN.md` — §3.4 artifact inventory: add `no-code-change-comment.json` (`{ issueKey, postedAt }`) with a note on the resume special case (valid `no-code-change.json` = implement-complete evidence → resume skips implement). - `docs/adr/021-no-code-change-comment.md` — already exists; leave untouched. - Validation: `npm run lint`, `npm test` (all unit suites incl. the new ones), `npm run build`, then the gated resume E2E (`PILOOP_E2E=1`) plus one real no-code-change run against a sandbox issue to eyeball the posted comment text. ## Acceptance Criteria - [ ] AGENTS.md contains the fatal error-policy row (no-code-change comment failure → abort, `error.json`, resumable) and the ADR-021 cross-reference in the ADR list. - [ ] DESIGN.md §3.4 documents `no-code-change-comment.json` with its `{ issueKey, postedAt }` shape and the resume special case. - [ ] `npm run lint`, `npm test`, and `npm run build` all green. - [ ] Gated resume E2E passes per the E2E issue; one real no-code-change run posts a legible comment. ## Test Plan - The validation sequence above IS the test plan — report results per command.

david added this to the No-code-change comment: verification & docs milestone

2026-09-05 18:36:22 +00:00

david added the

documentation

ready

labels

2026-09-05 18:36:22 +00:00

david referenced this issue from a pull request that will close it,

2026-09-05 20:20:12 +00:00

issue-311: Doc updates and validation for the no-code-change comment feature #318

david closed this issue

2026-09-05 20:20:13 +00:00