Skip to content

docs(governance): trim AGENTS.md narrative prose to the sober standard #NOT YET READY - #1583

Draft
djdomi wants to merge 40 commits into
current_devfrom
docs/1578-agents-md-sober-trim
Draft

docs(governance): trim AGENTS.md narrative prose to the sober standard #NOT YET READY#1583
djdomi wants to merge 40 commits into
current_devfrom
docs/1578-agents-md-sober-trim

Conversation

@djdomi

@djdomi djdomi commented Aug 15, 2026

Copy link
Copy Markdown
Member

CLD-1786825000

Summary

Trims AGENTS.md's own narrative-heavy rule prose to the "sober" standard already applied to code comments (AG-CODE-012), and separately adopts AG-VAL-033 and closes a real AG-REL-001 gap found along the way.

Linked Issues

Refs #1578. This is a governance-doc change (Rule-Ref: AG-CI-020's own trailing paragraph): stays open with Refs, never Closes, until confirmed live on master.

What This Actually Changes

Before: many rules (especially in Agent Workflow, Required Validation, Coding Patterns) carried a 100-300+ word inline incident retelling after their normative text -- the actual must/must not/scope/exception was buried inside the story of how the rule was discovered. After: the normative text is unchanged in substance; each incident retelling is compressed to a one-sentence Bad Example: citation pointing at the real PR/issue where the full detail still lives. Nothing normative was narrowed -- every must/must not, scope, exception, rule ID, and Rule-Ref: cross-reference survives; several bare mid-sentence references were upgraded to the required Rule-Ref: form as a side effect.

What This PR Fixes / Adds

What Changed In Code

AGENTS.md only -- 30 commits, one per rule/decision (explicit maintainer request for this refactor specifically, so every intermediate state stays independently revertable). No other file touched.

Why This Matters For Users / Operators

No runtime/operator-visible change. This is the project's own AI-agent governance document -- easier for a human or an agent to actually read and follow when the regulatory text isn't buried in a paragraph of incident narrative.

Scope Boundaries

Does not touch AG-WF-026, AG-WF-033, AG-KD-003, or AG-GH-018 -- reviewed and found to be either purely normative (no separable incident tail) or dense technical specification (byte thresholds, CVE/version tables) where trimming would cost real content, not prose. Does not rewrite the two scripts found under the new AG-REL-001 clause (tracked on issue #1095 instead).

Risk / Rollback / Follow-up

No behavioral risk -- documentation-only. Rollback: revert any single commit (or the whole branch) independently; each rule's trim is its own commit. Follow-up: maintainer review/reconciliation of all 30 commits against the original text (in progress); the two Python-in-bash scripts flagged under AG-REL-001 remain unfixed pending a separate scoping decision.

Local Scope Evidence

AGENTS.md | 60 +++++++++++++++++++++++++++++++-----------------------------
1 file changed, 31 insertions(+), 29 deletions(-)

Validation

# Rule-ID set identical before/after (no ID added, removed, or renumbered)
git show d7e7a344:AGENTS.md | grep -oE '\[AG-[A-Z]+-[0-9]+\]' | sort -u > before.txt
grep -oE '\[AG-[A-Z]+-[0-9]+\]' AGENTS.md | sort -u > after.txt
diff before.txt after.txt   # -> no output, identical

# Rule-Ref: cross-references: no loss, several bare references upgraded to Rule-Ref: form
# (manually diffed, see PR discussion)

# Retirement stubs (AG-WF-016's no-reuse mechanism) untouched
git show d7e7a344:AGENTS.md | grep -c retired   # -> 10
grep -c retired AGENTS.md                        # -> 10

# Section headers unchanged
diff <(git show d7e7a344:AGENTS.md | grep '^## ') <(grep '^## ' AGENTS.md)  # -> no output

No CI-relevant file touched; standard governance-content checks (file-headers, check-governance-guards.sh) apply automatically via build-push.yml on this PR.

Type of change

  • Bug fix
  • New feature
  • Refactor
  • Documentation
  • Chore

Changelog

Internal governance-document cleanup; no user-facing/operational change.

djdomi added 30 commits August 15, 2026 21:43
chore(governance): open worktree for #1578 AGENTS.md sober-prose trim
djdomi added 5 commits August 15, 2026 22:55
CLD-1786827787

Retire AG-GH-8 (Rule-Ref: AG-WF-016 stub) and split its three distinct
concerns into focused rules: AG-GH-23 (what metadata is required),
AG-GH-24 (where it comes from), AG-GH-25 (when it must be set and how
it's enforced). Drops the redundant Known Gaps mechanism paragraph in
favor of the Rule Enforcement Matrix rows plus scripts/check-pr-tracking-
metadata.sh's own comments, which already document the fork-PR and
secret-failure-mode nuance in full.

Refs #1578
@github-actions github-actions Bot added github_actions Pull requests that update GitHub Actions code ci Continuous integration and runner workflow changes tooling Developer or CI tooling work labels Aug 15, 2026
djdomi added 5 commits August 15, 2026 23:10
…ocal Windows Docker

CLD-1786828241

AG-VAL-016 already made the build-tools container the only valid
verification path but did not say where that container must run. Makes
explicit that a Windows authoring host (even with Docker Desktop
installed and apparently working) is not a substitute for SSH against a
real Linux self-hosted runner host -- grounded in AG-IPV6-001's already-
documented Docker-Desktop-on-Windows divergence.

Refs #1578
… instead of duplicating it

CLD-1786828283

Refs #1578
…ot a coordinator

CLD-1786859037

A coordinating agent could previously grant its own new-file ACK on the
maintainer's behalf ('maintainer/coordinator ACK'). Closes that loophole:
only the maintainer's explicit ACK lifts the new-file DISACK now.

Refs #1578
…ile ACK regardless of circumstance

CLD-1786859140

Refs #1578
djdomi added a commit that referenced this pull request Aug 19, 2026
PR #1583 (not yet merged) is trimming AGENTS.md's narrative-heavy rule
prose repo-wide; writing new prose in that same narrative style would
just be more work for that trim later. Compresses the incident retelling
to a two-sentence pointer at issues #815/#1095, matching the target
pattern -- normative content stays in the Rule Enforcement Matrix row.

CLD-1787166227

From: Issue #1599
@djdomi
djdomi changed the base branch from current_dev to fix/1598-build-tools-cve-sweep August 20, 2026 04:47
@djdomi
djdomi force-pushed the fix/1598-build-tools-cve-sweep branch from d17781e to fed0be7 Compare August 20, 2026 09:33
@djdomi djdomi changed the title docs(governance): trim AGENTS.md narrative prose to the sober standard docs(governance): trim AGENTS.md narrative prose to the sober standard - Out of Scope aslong not all rules has been adjusted to sober dry within it Aug 20, 2026
@djdomi djdomi changed the title docs(governance): trim AGENTS.md narrative prose to the sober standard - Out of Scope aslong not all rules has been adjusted to sober dry within it docs(governance): trim AGENTS.md narrative prose to the sober standard #NOT YET READY Aug 20, 2026
@djdomi
djdomi force-pushed the fix/1598-build-tools-cve-sweep branch 4 times, most recently from 494aabc to d92d507 Compare August 20, 2026 15:39
Base automatically changed from fix/1598-build-tools-cve-sweep to current_dev August 20, 2026 15:41
Comment thread AGENTS.md

This comment was marked as resolved.

djdomi added a commit that referenced this pull request Aug 22, 2026
… 3 lines / <=80 chars

What: trims the What/Why/From comment blocks this PR itself introduced
(the one full-detail copy per step type, on detect-changes' occurrence
of each of the three new steps -- all other 30 sites already carry no
comment) from 5-6 lines down to exactly 3 lines each, all <=80 chars,
with no loss of the What/Why/From substance itself.

Why: maintainer feedback relayed via the coordinator during this PR's
own review cycle, citing build-push.yml as a named example of comment
blocks growing without a length ceiling, contributing to the file's own
AG-CI-021 size guard margin being fragile. Scoped to only this PR's own
new comment blocks, not the rest of the file's pre-existing comments --
a much larger sweep was proposed separately and is intentionally NOT
part of this commit pending direct confirmation, since the specific
3-line/80-char ceiling cited is not yet present in AG-CODE-012 on
origin/current_dev as of this commit (current text: 5-line ceiling,
Why: 1-3 lines) and the PR proposing that tightening (#1583) is itself
still a draft explicitly marked not-yet-ready.

Verified: scripts/untracked/check-workflow-line-limit.sh still passes
(8759/8999 lines, 510777/512000 bytes); bash -n still passes on all 219
run: blocks; the 31/31/31 structural placement check still passes; a
targeted awk scan confirms none of this PR's own three comment blocks
exceed 80 characters (the only >80-char "# What/Why/From:" lines
remaining in the file are pre-existing, not touched by this commit).

From: Issue #1095 | PR #1645
djdomi added a commit that referenced this pull request Aug 22, 2026
… 3 lines / <=80 chars

What: trims the What/Why/From comment blocks this PR itself introduced
(the one full-detail copy per step type, on detect-changes' occurrence
of each of the three new steps -- all other 30 sites already carry no
comment) from 5-6 lines down to exactly 3 lines each, all <=80 chars,
with no loss of the What/Why/From substance itself.

Why: maintainer feedback relayed via the coordinator during this PR's
own review cycle, citing build-push.yml as a named example of comment
blocks growing without a length ceiling, contributing to the file's own
AG-CI-021 size guard margin being fragile. Scoped to only this PR's own
new comment blocks, not the rest of the file's pre-existing comments --
a much larger sweep was proposed separately and is intentionally NOT
part of this commit pending direct confirmation, since the specific
3-line/80-char ceiling cited is not yet present in AG-CODE-012 on
origin/current_dev as of this commit (current text: 5-line ceiling,
Why: 1-3 lines) and the PR proposing that tightening (#1583) is itself
still a draft explicitly marked not-yet-ready.

Verified: scripts/untracked/check-workflow-line-limit.sh still passes
(8759/8999 lines, 510777/512000 bytes); bash -n still passes on all 219
run: blocks; the 31/31/31 structural placement check still passes; a
targeted awk scan confirms none of this PR's own three comment blocks
exceed 80 characters (the only >80-char "# What/Why/From:" lines
remaining in the file are pre-existing, not touched by this commit).

From: Issue #1095 | PR #1645
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Continuous integration and runner workflow changes documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code tooling Developer or CI tooling work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant