Skip to content

Commit 4828d36

Browse files
committed
Clarify README and release metadata
1 parent 25efa79 commit 4828d36

5 files changed

Lines changed: 98 additions & 9 deletions

File tree

.github/workflows/rule-governance.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ on:
1616
- "prompt-budget.local.example.yml"
1717
- "CHANGELOG.md"
1818
- "MIGRATION.md"
19+
- "VERSION"
1920
- "scripts/*.sh"
2021
- "scripts/*.py"
2122
pull_request:
@@ -32,6 +33,7 @@ on:
3233
- "prompt-budget.local.example.yml"
3334
- "CHANGELOG.md"
3435
- "MIGRATION.md"
36+
- "VERSION"
3537
- "scripts/*.sh"
3638
- "scripts/*.py"
3739
workflow_dispatch:

CHANGELOG.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,59 @@ Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
66

77
---
88

9+
## [0.20.0] - 2026-04-30
10+
11+
### Added
12+
13+
- **`VERSION`** — new release metadata file tracking the current template
14+
version. The template now declares `0.20.0` in a small machine-readable file
15+
instead of relying only on changelog headings.
16+
17+
### Changed
18+
19+
- **`README.md`** — rewritten project introduction so first-time readers can
20+
immediately understand the repository's purpose: a portable governance layer
21+
for AI coding agents, not an app runtime. Added a concrete inventory covering
22+
rules, skills, adapter harnesses, scripts, GitHub workflows, evals, context
23+
packs, and release metadata.
24+
25+
- **Decision policy guidance** — README, reusable templates, and documentation
26+
skills now describe decision capture in terms of `prompt-budget.yml`
27+
`decision_log.policy`. Adopted projects normally write `DECISIONS.md`; this
28+
template repo keeps `DECISIONS.md` example-only and records task decisions in
29+
summaries, handoffs, or traces.
30+
31+
- **Rule contract governance** — domain rule templates now use the canonical
32+
rule-entry contract (`Directive`, `Rationale`, `Conflict handling`, `Example`,
33+
`Non-example`). `scripts/lint-layered-rules.sh` now rejects active rules that
34+
omit required canonical fields or leave whole-field placeholders behind.
35+
36+
- **Budget reporting**`scripts/budget-report.sh` now checks the actual
37+
`skills.always_load` set against `layer2_max_tokens` and reports the full
38+
skill catalog as informational. The tracked `prompt-budget.yml` targets were
39+
updated to match the current standard-profile baseline while the optimization
40+
roadmap continues to track future slimming.
41+
42+
### Fixed
43+
44+
- **Context-pack decision parsing**`scripts/build-context-pack.py` and
45+
`scripts/decisions-conflict-check.py` now ignore HTML comment blocks in
46+
`DECISIONS.md`, preventing the example decision template from being treated
47+
as a real decision entry.
48+
49+
- **Trace review alignment**`docs/schemas/trace.schema.yaml` and the bundled
50+
medium trace example now agree that Medium/Large traces include
51+
`task_summary`; `scripts/agent-review.sh` no longer reports a finding on the
52+
checked-in example trace.
53+
54+
### Tooling
55+
56+
- **`evals/tooling/context-pack-determinism/expected.json`** — refreshed after
57+
the context-pack parser and rule/budget metadata changes so deterministic
58+
tooling tests reflect the current contract.
59+
60+
---
61+
962
## [0.19.0] - 2026-04-29
1063

1164
### Added
@@ -663,6 +716,7 @@ Initial release of the agent playbook template.
663716

664717
---
665718

719+
[0.20.0]: https://github.com/screenleon/agent-playbook-template/compare/v0.19.0...v0.20.0
666720
[0.19.0]: https://github.com/screenleon/agent-playbook-template/compare/v0.18.0...v0.19.0
667721
[0.3.0]: https://github.com/screenleon/agent-playbook-template/compare/v0.2.0...v0.3.0
668722
[0.5.0]: https://github.com/screenleon/agent-playbook-template/compare/v0.4.0...v0.5.0

README.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,28 @@
11
# Agent Playbook Template
22

3+
Agent Playbook Template is a portable governance framework for AI coding agents.
4+
It gives a repository a version-controlled source of truth for how agents load
5+
context, route work by role, handle approval gates, validate changes, record
6+
decisions, and hand off structured context across tools.
7+
8+
Use this template when you want repeatable agent behavior across Codex, Claude,
9+
Copilot, Cursor, OpenCode, Windsurf, or a generic CLI workflow. It is not an app
10+
runtime or product framework; it is the operating layer around agent-assisted
11+
software work.
12+
13+
## What This Repository Contains
14+
15+
- Root agent instructions through `AGENTS.md`
16+
- Source-of-truth operating and routing docs in `docs/`
17+
- Layered reusable rules in `rules/global/`, `rules/domain/`, and `project/`
18+
- Reusable skills in `skills/*/SKILL.md`
19+
- Tool-specific agent surfaces for Claude and GitHub Copilot
20+
- Adapter harnesses for Claude Code, Copilot, Cursor, OpenCode, Windsurf, and generic CLI use
21+
- Governance scripts for linting, budget reporting, trace review, context-pack generation, and eval scoring
22+
- GitHub Actions workflows for markdown lint, rule governance, and trace review
23+
- Evals and deterministic tooling fixtures for checking governance behavior
24+
- Release metadata in `VERSION` and `CHANGELOG.md`
25+
326
## Quick-start onboarding paths
427

528
Choose the path that fits your situation — all three lead to the same governance model.
@@ -59,15 +82,15 @@ The table below shows how each governance gate behaves across the three trust le
5982

6083
Legend: **STOP** = agent pauses and waits for human input. **Advisory** = agent logs the event and continues. Gate behavior is defined in `docs/operating-rules.md` → Trust level.
6184

62-
## Quick Start (3 steps)
85+
## Adopter Quick Start
6386

6487
1. Copy this template into your repository (or create a repo from this template).
6588
2. Edit the two source-of-truth docs first: `docs/operating-rules.md` and `docs/agent-playbook.md`. Update `AGENTS.md` after them as the root entrypoint.
66-
3. Run your first task with the required workflow: discover -> triage -> plan (if needed) -> implement -> validate -> record decisions.
89+
3. Run your first task with the required workflow: discover -> triage -> plan (if needed) -> implement -> validate -> record decisions according to `prompt-budget.yml` -> `decision_log.policy`.
6790

6891
For first entry into a new repository, use the profile-aware initialization path: at `minimal`, follow the manual scan path in `docs/rules-quickstart.md`; at `standard`/`full`, run `skills/on-project-start/SKILL.md` before implementation.
6992

70-
If you only do one thing on day one: keep `DECISIONS.md` updated so future agent runs can perform contradiction checks.
93+
If you only do one thing on day one after adopting this template: switch `decision_log.policy` to `normal` and keep `DECISIONS.md` updated so future agent runs can perform contradiction checks.
7194

7295
## Mental model
7396

@@ -141,7 +164,7 @@ flowchart LR
141164
D --> E[Role Selection]
142165
E --> F[skills/*/SKILL.md]
143166
F --> G[Implementation + Validation Loop]
144-
G --> H[DECISIONS.md Update]
167+
G --> H[Decision Record<br/>per decision_log.policy]
145168
H --> I[Future Contradiction Checks]
146169
```
147170

@@ -167,7 +190,7 @@ For staged simplification and automation steps, see `docs/rule-optimization-plan
167190
4. Plan path: Small uses the simplified path; bounded Medium work may go directly to implementation; ambiguous, high-risk, or cross-module Medium/Large work uses the full planning path.
168191
5. Implement safely: keep scope tight and follow repository patterns.
169192
6. Validate: run targeted checks/tests, fix, and repeat until stable.
170-
7. Record durable state: update `DECISIONS.md` when behavior or architecture choices are made.
193+
7. Record durable state according to `prompt-budget.yml` -> `decision_log.policy`: adopted projects usually update `DECISIONS.md`; this template repo records task decisions in summaries, handoffs, or traces.
171194

172195
This flow is what makes the template useful in real teams: predictable output quality, lower drift, and faster onboarding.
173196

@@ -192,13 +215,19 @@ If you maintain a fork, keep these phrases in your repository description and RE
192215
- a machine-readable context-pack contract for multi-tool orchestration
193216
- a canonical trace schema (`docs/schemas/trace.schema.yaml`) usable by any adapter
194217
- an adapter-neutral evals framework (`evals/`) that verifies governance rules across tools
218+
- harness adapters and shell-first governance scripts for local and CI validation
195219
- reusable skills you can adapt into your own agent ecosystem
196220
- repo-wide Copilot instructions
197221

198222
## Current asset inventory
199223

224+
- Version: 0.20.0 (`VERSION`)
200225
- Claude subagents: 8 (`.claude/agents/*.md`)
201226
- Reusable skills: 18 (`skills/*/SKILL.md`)
227+
- Governance scripts: 14 (`scripts/*`)
228+
- GitHub workflows: 3 (`.github/workflows/*.yml`)
229+
- Adapter harnesses: 6 (`harness/adapters/*`)
230+
- Example profiles and notes: 4 (`examples/*.md`)
202231
- Source-of-truth docs: `docs/operating-rules.md`, `docs/agent-playbook.md` (`AGENTS.md` is the root entrypoint that should stay aligned with them)
203232

204233
## Example gallery
@@ -208,6 +237,7 @@ Use `examples/` for ready-to-adapt constraint profiles:
208237
- `examples/high-security-mode.md`
209238
- `examples/mvp-rapid-mode.md`
210239
- `examples/legacy-maintenance.md`
240+
- `examples/anti-patterns.md`
211241

212242
## Required vs optional files
213243

@@ -234,6 +264,8 @@ Use `examples/` for ready-to-adapt constraint profiles:
234264
- `docs/example-task-walkthrough.md` — reference for expected output formats
235265
- `docs/external-practices-notes.md`
236266
- `docs/adoption-guide.md`
267+
- `harness/` — adapter hooks and wrapper scripts for tools that support or emulate governance hooks
268+
- `evals/` — adapter-neutral behavior fixtures and scoring helpers
237269

238270
## Adoption path
239271

VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.20.0

evals/tooling/context-pack-determinism/expected.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,18 @@
3838
"orchestration": {
3939
"budget": {
4040
"allocated": {
41-
"entrypoint": 3970,
41+
"entrypoint": 4338,
4242
"reserve": 1200,
43-
"rules": 6830
43+
"rules": 6462
4444
},
4545
"estimate_method": "word_count*1.35",
4646
"profile": "standard",
4747
"target_total_tokens": 12000
4848
},
4949
"determinism": {
5050
"builder_version": "1.0.0",
51-
"input_hash": "sha256:baf218e89141bbd6900ef6b09b12ccb6d14d7971ed8eb744d8eae8fb3cbf2565",
52-
"output_hash": "sha256:8dad16c4d5d3113a98a3b45265f13a278a18d403599a001c283ffaf5cc304305"
51+
"input_hash": "sha256:12c89274afa60281d42317847967718c1f27b5b26013d7430db17597f2ac43a2",
52+
"output_hash": "sha256:ed00d4ccbd0dca37799cc214308e73e3e157d6b580606447a80f036738558c25"
5353
},
5454
"dropped": [
5555
{

0 commit comments

Comments
 (0)