Skip to content

Commit 7d1196d

Browse files
committed
Remove working planning files and enforce repository hygiene
1 parent be2e891 commit 7d1196d

124 files changed

Lines changed: 606 additions & 9539 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/AGENTS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@
2929
- Validation and publication jobs retain least privileges and separate website-source and measured-source revisions. Publication must continue to use qualified measured-source checkout and cannot infer current database qualification from a historical site test. A validation result never authorizes DNS or public deployment.
3030

3131
## Fresh-evidence publication extension
32-
- The owner's subsequent separate post-test deployment request is REQ/AC-BC-028 under ADR-040 and `site-publication.acceptance.md`/`.plan.md`. Preserve every prior policy and measured-source checkout; this new task authorizes the publication workflow after its complete gates. DNS remains excluded.
32+
- The owner's subsequent separate post-test deployment request is REQ/AC-BC-028 under ADR-040 and the publication acceptance/execution contract in `docs/Features/BenchmarkComparisons.md`. Preserve every prior policy and measured-source checkout; this new task authorizes the publication workflow after its complete gates. DNS remains excluded.
3333
- `pages.yml` MUST use trusted selection, one complete qualification/build path and a needs-gated deploy-only job. Only deployment receives Pages/OIDC writes. Qualification MUST retain all existing tests, native thresholds, real Chrome, format and governance without skips or fake transport.
3434
- Publish MUST require the highest authenticated own-main-push CI run/current attempt itself successful, exact successful comparison job/steps, one immutable unexpired artifact and verified same-archive bytes; newer unsuccessful work blocks refresh. Recheck the complete tuple immediately before deployment. Historical pinning is validation-only.
3535
- Record actual checkout source separately from triggering/control workflow SHA. Published measurements and report hashes MUST match the downloaded qualified JSON; successful workflow/provider/live evidence is required before claiming publication.
3636

3737
## Owner-directed site-only boundary, 2026-10-02
38-
- The owner's explicit subsequent instruction to finish only the website supersedes the earlier BC028 conservative-B/equal-website-and-measured-SHA task restrictions above. Preserve those records; the current implementation contract is site-publication.acceptance.md and ADR-040. Inspect measured source in a separate sibling checkout; qualify current trusted-main website source independently and record every revision accurately.
38+
- The owner's explicit subsequent instruction to finish only the website supersedes the earlier BC028 conservative-B/equal-website-and-measured-SHA task restrictions above. Preserve those records; the current implementation contract is the BenchmarkComparisons publication acceptance/execution contract and ADR-040. Inspect measured source in a separate sibling checkout; qualify current trusted-main website source independently and record every revision accurately.
3939
- Select the highest successful actual comparison job by main-push run number and descending attempt history, independent of unrelated job or overall workflow conclusion. After selecting success, missing/expired/ambiguous artifacts and invalid reports MUST fail without fallback. Recheck both current website source and the exact evidence tuple before deployment.
4040
- The separate pages.yml MUST trigger on main site/** changes, producer workflow completion and manual dispatch. workflow_run arrives after the enclosing workflow; do not claim an individual-job webhook. Full website qualification and least privileges remain mandatory; database implementation and DNS remain outside this task.
4141

‎.github/workflows/Features/BenchmarkComparisons/BuildIsolatedSite/AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Purpose and entry points
44
- Own the final BenchmarkComparisons website build composite action; entry point: action.yml.
5-
- Read the root AGENTS.md, workflows/AGENTS.md, docs/Architecture.md, BenchmarkComparisons feature, isolated-comparisons.acceptance.md TASK-ISO-012P and ADR-056 before changes.
5+
- Read the root AGENTS.md, workflows/AGENTS.md, docs/Architecture.md, BenchmarkComparisons feature with TASK-ISO-012P acceptance/execution contracts and ADR-056 before changes.
66

77
## Boundaries
88
- Run from the actual qualified website checkout after all native site/analyzer TUnit, coverage and no-skip gates pass. Keep website, historical measured, isolated measured and workflow-control revisions independent.

‎.gitignore‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -656,18 +656,6 @@ MigrationBackup/
656656
_site/
657657

658658

659-
#plans
660-
*.plan.md
661-
662-
# Local task scaffolding; durable specifications remain in docs/.
663-
/*.brainstorm.md
664-
/*.acceptance.md
665-
666-
# Required source artifacts checked by RepositoryGovernance in CI.
667-
!/mcaf-governance.brainstorm.md
668-
!/mcaf-governance.acceptance.md
669-
!/mcaf-governance.plan.md
670-
671659
# KeyLoad local databases, credentials and qualification artifacts
672660
artifacts/
673661
data/
@@ -685,3 +673,8 @@ output/playwright/
685673
*.ctg
686674
*.tmp
687675
*.binlog
676+
677+
# Agent working notes; durable contracts live in docs/Features/ and docs/ADR/.
678+
*.plan.md
679+
*.brainstorm.md
680+
*.acceptance.md

‎AGENTS.md‎

Lines changed: 43 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -241,61 +241,53 @@ Local `AGENTS.md` files may tighten these values, but they must not loosen them
241241
- current state
242242
- required change
243243
- constraints and risks
244-
- Before starting a brainstorm, decide whether the task is actually non-trivial.
245-
- For non-trivial work, create a root-level `<slug>.brainstorm.md` file before making code or doc changes.
246-
- For simple, short, or obvious work, skip the brainstorm and go directly to execution.
247-
- Use `<slug>.brainstorm.md` to capture the problem framing, options, trade-offs, risks, open questions, and the recommended direction.
248-
- Think through the task in the brainstorm before committing to implementation details.
249-
- Before creating `<slug>.plan.md`, create a root-level `<slug>.acceptance.md` file.
250-
- The acceptance criteria file MUST be detailed enough that another agent or maintainer can implement and test the task without rereading the conversation.
251-
- The acceptance criteria file MUST contain:
244+
- Before starting design analysis, decide whether the task is actually non-trivial.
245+
- For non-trivial work, record problem framing, options, trade-offs, risks, open questions and the recommended direction in the owning feature specification and required ADR before code or doc implementation.
246+
- For simple, short or obvious work, go directly to execution.
247+
- Keep temporary brainstorms and working checklists in agent context or outside the checkout; do not create separate planning Markdown files in the repository.
248+
- Think through options before committing to implementation details.
249+
- Before ordering implementation, define the acceptance contract in the owning feature specification.
250+
- The acceptance contract MUST be detailed enough that another agent or maintainer can implement and test the task without rereading the conversation.
251+
- The acceptance contract MUST contain:
252252
- task goal and user-visible outcome
253253
- in-scope and out-of-scope behaviour
254254
- assumptions and open questions
255-
- actors, entry points, permissions, and affected boundaries
256-
- numbered criteria with stable IDs such as `AC-001`, `AC-002`, and `AC-003`
255+
- actors, entry points, permissions and affected boundaries
256+
- numbered criteria with stable IDs such as `AC-001`, `AC-002` and `AC-003`
257257
- clear pass and fail conditions for every criterion
258-
- positive flows, negative flows, edge cases, and unexpected/error paths
259-
- data, contract, API, UI, persistence, performance, security, and observability expectations where relevant
260-
- migration, compatibility, and rollback expectations where relevant
261-
- a criterion-to-test matrix that maps each `AC-*` item to planned automated tests, test level, assertions, and verification commands
262-
- explicit criteria that will not receive automated coverage, with the reason and required manual or review evidence
263-
- Do not start implementation until the acceptance criteria file exists and the test strategy maps back to it.
264-
- After the acceptance criteria are written, create a root-level `<slug>.plan.md` file derived from `<slug>.acceptance.md`.
265-
- Keep the `<slug>.plan.md` file as the working plan for the task until completion.
266-
- The plan file MUST contain:
267-
- a link or reference to the chosen brainstorm
268-
- a link or reference to the acceptance criteria file
258+
- positive flows, negative flows, edge cases and unexpected/error paths
259+
- data, contract, API, UI, persistence, performance, security and observability expectations where relevant
260+
- migration, compatibility and rollback expectations where relevant
261+
- a criterion-to-test matrix mapping each `AC-*` to automated tests, test level, assertions and verification commands
262+
- explicit criteria without automated coverage, with the reason and required manual or review evidence
263+
- Do not start implementation until the acceptance contract exists and the test strategy maps back to it.
264+
- Derive the ordered execution contract from the accepted criteria and keep it in the feature specification and required ADR, with one canonical source for each fact.
265+
- The execution contract MUST contain:
266+
- the chosen design analysis and acceptance contract
269267
- implementation steps derived from the accepted `AC-*` criteria
270268
- task goal and scope
271-
- a detailed implementation plan with detailed ordered steps
272-
- constraints and risks
273-
- explicit test steps as part of the ordered plan, not as a later add-on
274-
- a test plan derived from the `AC-*` criteria, with every criterion covered by tests or a documented exception
275-
- the test and verification strategy for each planned step
276-
- the testing methodology for the task: what flows will be tested, how they will be tested, and what quality bar the tests must meet
277-
- an explicit full-test baseline step after the plan is prepared
278-
- a tracked list of already failing tests, with one checklist item per failing test
279-
- root-cause notes and intended fix path for each failing test that must be addressed
280-
- a checklist with explicit done criteria for each step
281-
- ordered final validation skills and commands, with reason for each
269+
- detailed ordered implementation steps, constraints and risks
270+
- explicit test steps within the ordered implementation, not as a later add-on
271+
- a test strategy for every step, covering each `AC-*` with a test or documented exception
272+
- the testing methodology: flows, commands and quality bar
273+
- a full relevant test baseline before implementation
274+
- a tracked list of already failing tests, their failure symptoms, suspected causes and intended fixes
275+
- checklist completion conditions
276+
- ordered final validation skills and commands, with the reason for each
282277
- Use the Ralph Loop for every non-trivial task:
283-
- brainstorm in `<slug>.brainstorm.md` before coding or document edits
284-
- think through options and choose the intended direction before planning
285-
- turn the chosen direction into detailed acceptance criteria in `<slug>.acceptance.md`
286-
- map every acceptance criterion to planned automated tests or a documented test exception before coding
287-
- turn the chosen direction into a detailed `<slug>.plan.md`
288-
- include test creation, test updates, and verification work in the ordered steps from the start
289-
- once the initial plan is ready, run the full relevant test suite to establish the real baseline
290-
- if tests are already failing, add each failing test back into `<slug>.plan.md` as a tracked item with its failure symptom, suspected cause, and fix status
291-
- work through failing tests one by one: reproduce, find the root cause, apply the fix, rerun, and update the plan file
292-
- include ordered final validation skills in the plan file, with reason for each skill
293-
- require each selected skill to produce a concrete action, artifact, or verification outcome
294-
- execute one planned step at a time
295-
- mark checklist items in `<slug>.plan.md` as work progresses
296-
- update `<slug>.acceptance.md` when the criteria change, then update the mapped tests and plan before continuing
297-
- review findings, apply fixes, and rerun relevant verification
298-
- update the plan file and repeat until done criteria are met; document blockers explicitly without weakening an acceptance criterion or mandatory rule.
278+
- analyze the problem and options before implementation
279+
- write detailed acceptance criteria in the owning feature specification
280+
- map every criterion to automated tests or a documented exception before coding
281+
- derive the ordered execution contract in the feature specification and required ADR
282+
- include test creation, updates and verification from the start
283+
- run the full relevant suite to establish the real baseline once the execution contract is ready
284+
- record existing failures, symptoms, suspected causes and fix status in the execution contract
285+
- reproduce and fix failures one by one, rerun the tests and update their status
286+
- include ordered final validation skills, with each producing a concrete action, artifact or verification outcome
287+
- execute one step at a time and track its completion
288+
- when criteria change, update the acceptance contract, mapped tests and execution contract before continuing
289+
- review findings, apply fixes and rerun relevant verification
290+
- repeat until all completion conditions pass; document blockers without weakening an acceptance criterion or mandatory rule
299291
- Implement code and tests together.
300292
- Run verification in layers:
301293
- changed tests
@@ -320,7 +312,7 @@ Local `AGENTS.md` files may tighten these values, but they must not loosen them
320312
- Update ADRs when architecture, boundaries, or standards change.
321313
- Every non-trivial feature doc MUST satisfy `MCAF-REQ-001`: stable `REQ-*` and `AC-*`, explicit ADR decision, multi-agent execution contract when applicable, and requirement-to-test evidence traceability.
322314
- Every architecture-affecting ADR MUST include its implementation contract and MUST remain `Accepted` until implementation and verification are complete.
323-
- For non-trivial work, the acceptance criteria file, plan file, feature doc, or ADR MUST document the testing methodology:
315+
- For non-trivial work, the owning feature specification and required ADR MUST document the testing methodology:
324316
- what flows are covered
325317
- how they are tested
326318
- which commands prove them
@@ -334,7 +326,7 @@ Local `AGENTS.md` files may tighten these values, but they must not loosen them
334326
- TDD is the default for new behaviour and bug fixes: write the failing test first, make it pass, then refactor.
335327
- Bug fixes start with a failing regression test that reproduces the issue.
336328
- Tests MUST be written from acceptance criteria, not from implementation details.
337-
- Each `AC-*` criterion in `<slug>.acceptance.md` MUST be covered by one or more automated tests or by an explicit written exception.
329+
- Each `AC-*` criterion in the owning feature specification MUST be covered by one or more automated tests or by an explicit written exception.
338330
- Test names, display names, or comments should reference the relevant `AC-*` ID when that improves traceability.
339331
- Every behaviour change needs new or updated automated tests with meaningful assertions. New tests are mandatory for new behaviour and bug fixes.
340332
- Tests must prove the real user flow or caller-visible system flow, not only internal implementation details.
@@ -416,6 +408,7 @@ For changes outside existing owner authorization, obtain direction before changi
416408
- The central KeyLoad K MUST use the canonical true SVG outside the bounded 3D raster buffer so it stays sharp on Retina displays. An SVG wrapper around a bitmap or a CanvasTexture logo does not satisfy this requirement (repeated owner correction 2026-10-03).
417409
### Dislikes
418410
- Repeated permission questions for already authorized work.
411+
- Working `*.plan.md`, `*.brainstorm.md` and `*.acceptance.md` files MUST NOT be created or committed anywhere in this checkout. Remove existing copies and ignore these patterns without exceptions. Keep durable requirements, acceptance criteria and execution/verification contracts in the owning `docs/Features/` specification and required ADR; agent working notes stay outside the repository. This explicit owner correction on 2026-10-03 supersedes every root/local instruction requiring separate planning files without weakening feature, test, architecture or qualification requirements.
419412
- The root README MUST NOT accumulate CI run histories, test counts, internal implementation receipts, governance procedures, or package/version dumps. Keep a concise honest development-status statement and link to the canonical status and qualification records instead (owner correction 2026-10-03).
420413
- GitHub Actions MUST expose exactly three plainly named workflows: CI combines build and ordinary project tests for PR/push/manual checks; Benchmarks runs all load/comparison suites, produces complete authenticated measurements and then qualifies/publishes the website; Release builds the solution, real database images/distribution and packages, then creates a GitHub Release and immutable version tag. Do not split Tests or Website into additional workflows (explicit owner correction 2026-10-03 supersedes the earlier five-workflow layout).
421414
- Release tags MUST be `v<major>.<minor>.<yyMMdd>.<daily-build>`: major/minor are configured in source, the third component is the UTC date and the fourth starts at 1 each day and increases without tag reuse or overwrite. Build/package/image/manifest identities MUST agree; reruns recover their original reservation. Release automation is authorized to create the corresponding Git tag, GitHub Release and versioned database image/package assets; preserve protections and qualification gates (owner direction 2026-10-03).

0 commit comments

Comments
 (0)