create-agdf 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -5
- package/bin/create-agdf.js +17 -0
- package/generated/.agdf/control/README.md +39 -0
- package/generated/.agdf/control/templates/AGDF_RUN.md +84 -0
- package/generated/.agdf/control/templates/AGENT_QUALITY_CONTRACTS.json +78 -0
- package/generated/.agdf/control/templates/CONTEXT_GRAPH.md +51 -0
- package/generated/.agdf/control/templates/MASTER_BACKLOG.md +29 -0
- package/generated/.agdf/control/templates/SOT_REGISTRY.md +25 -0
- package/generated/.github/skills/README.md +3 -2
- package/generated/.github/skills/agdf-clean-implementation-review/SKILL.md +1 -1
- package/generated/.github/skills/agdf-code-review/SKILL.md +94 -0
- package/generated/.github/skills/agdf-qa-gate/SKILL.md +2 -2
- package/generated/.github/skills/agdf-release-or/SKILL.md +2 -1
- package/generated/.github/skills/agdf-runtime-contract.md +13 -0
- package/generated/AGENTS.md +14 -1
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# create-agdf
|
|
2
2
|
|
|
3
|
-
Bootstrap AGDF for one repository.
|
|
3
|
+
Bootstrap AGDF repository instructions for one repository.
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
@@ -16,15 +16,35 @@ Optional flags:
|
|
|
16
16
|
|
|
17
17
|
## Targets and existing AGENTS.md
|
|
18
18
|
|
|
19
|
-
- `copilot` writes `AGENTS.md
|
|
20
|
-
- `both` writes the same Copilot-facing files and reminds you to install the Claude plugin separately
|
|
19
|
+
- `copilot` writes `AGENTS.md`, visible repository skills under `.github/skills/`, and AGDF control templates under `.agdf/control/`
|
|
20
|
+
- `both` writes the same Copilot-facing files and reminds you to install the Claude Code plugin separately
|
|
21
21
|
|
|
22
22
|
If the target repository already has an `AGENTS.md`, `create-agdf` preserves it and writes `AGENTS.agdf.md` instead of replacing your existing instructions. Merge the AGDF fragment into your current `AGENTS.md` when you want Copilot to load both instruction sets. Use `--force` only when you explicitly want to overwrite generated files.
|
|
23
23
|
|
|
24
|
+
Codex is supported through the AGDF Codex plugin in `plugin/.codex-plugin/plugin.json`, not through `create-agdf` package output.
|
|
25
|
+
|
|
26
|
+
## Control scaffold
|
|
27
|
+
|
|
28
|
+
The generated `.agdf/control/templates/` files are starting points for durable AGDF state:
|
|
29
|
+
|
|
30
|
+
- `AGDF_RUN.md` for the current run dashboard
|
|
31
|
+
- `MASTER_BACKLOG.md` for active delivery pointers
|
|
32
|
+
- `SOT_REGISTRY.md` for one source of truth per domain
|
|
33
|
+
- `CONTEXT_GRAPH.md` for durable Brownfield findings, decisions, risks, evidence and exit criteria
|
|
34
|
+
- `AGENT_QUALITY_CONTRACTS.json` for reusable block, revise and warning conditions
|
|
35
|
+
|
|
36
|
+
Copy or promote templates into live `.agdf/control/` files only when the target repository is ready to own them as source-of-truth artefacts.
|
|
37
|
+
|
|
24
38
|
## Single source of truth
|
|
25
39
|
|
|
26
|
-
The AGDF
|
|
27
|
-
|
|
40
|
+
The repository-facing AGDF sources are maintained in:
|
|
41
|
+
|
|
42
|
+
- `plugin/meta/agdf-copilot-agents.md`
|
|
43
|
+
- `plugin/skills/`
|
|
44
|
+
- `plugin/meta/agdf-runtime-contract.md`
|
|
45
|
+
- `plugin/control/`
|
|
46
|
+
|
|
47
|
+
The published package assets are generated from these repository sources only at pack/publish time. The package does not keep a second manually maintained template tree.
|
|
28
48
|
|
|
29
49
|
```bash
|
|
30
50
|
npm run sync-package-assets
|
package/bin/create-agdf.js
CHANGED
|
@@ -11,6 +11,14 @@ const generatedRoot = join(packageRoot, "generated");
|
|
|
11
11
|
const pluginInstallCommand = "claude plugin add arndtgold/ai-native-governance-delivery-framework";
|
|
12
12
|
const allowedTargets = new Set(["copilot", "both"]);
|
|
13
13
|
const agdfFragmentPath = "AGENTS.agdf.md";
|
|
14
|
+
const controlFiles = [
|
|
15
|
+
join(".agdf", "control", "README.md"),
|
|
16
|
+
join(".agdf", "control", "templates", "AGDF_RUN.md"),
|
|
17
|
+
join(".agdf", "control", "templates", "MASTER_BACKLOG.md"),
|
|
18
|
+
join(".agdf", "control", "templates", "SOT_REGISTRY.md"),
|
|
19
|
+
join(".agdf", "control", "templates", "CONTEXT_GRAPH.md"),
|
|
20
|
+
join(".agdf", "control", "templates", "AGENT_QUALITY_CONTRACTS.json"),
|
|
21
|
+
];
|
|
14
22
|
const copilotSkillFiles = [
|
|
15
23
|
join(".github", "skills", "README.md"),
|
|
16
24
|
join(".github", "skills", "agdf-runtime-contract.md"),
|
|
@@ -18,6 +26,7 @@ const copilotSkillFiles = [
|
|
|
18
26
|
join(".github", "skills", "agdf-brownfield-analysis", "SKILL.md"),
|
|
19
27
|
join(".github", "skills", "agdf-task-plan-review", "SKILL.md"),
|
|
20
28
|
join(".github", "skills", "agdf-clean-implementation-review", "SKILL.md"),
|
|
29
|
+
join(".github", "skills", "agdf-code-review", "SKILL.md"),
|
|
21
30
|
join(".github", "skills", "agdf-qa-gate", "SKILL.md"),
|
|
22
31
|
join(".github", "skills", "agdf-release-or", "SKILL.md"),
|
|
23
32
|
join(".github", "skills", "agdf-delivery-closeout", "SKILL.md"),
|
|
@@ -126,6 +135,13 @@ function generatedFilesForTarget(target, targetDir, force) {
|
|
|
126
135
|
];
|
|
127
136
|
|
|
128
137
|
if (target === "copilot" || target === "both") {
|
|
138
|
+
for (const controlPath of controlFiles) {
|
|
139
|
+
files.push({
|
|
140
|
+
path: controlPath,
|
|
141
|
+
content: loadAsset(controlPath),
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
|
|
129
145
|
for (const skillPath of copilotSkillFiles) {
|
|
130
146
|
files.push({
|
|
131
147
|
path: skillPath,
|
|
@@ -156,6 +172,7 @@ function printNextSteps(target, destination, files, wroteAgentsFragment) {
|
|
|
156
172
|
}
|
|
157
173
|
if (target === "copilot" || target === "both") {
|
|
158
174
|
console.log("- In GitHub Copilot CLI, run /instructions after the AGENTS.md step is complete to confirm that AGDF instructions and the repository skills are visible.");
|
|
175
|
+
console.log("- Copy the templates under .agdf/control/templates into live control files when the repository needs a durable run state, backlog pointer, SoT registry or context graph.");
|
|
159
176
|
}
|
|
160
177
|
console.log("- Commit the generated files so the repository becomes the source of truth.");
|
|
161
178
|
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# AGDF Control Scaffold
|
|
2
|
+
|
|
3
|
+
AGDF is primarily a control system for AI-assisted delivery. The skills guide the agent during a run; these files make the run state durable in a repository.
|
|
4
|
+
|
|
5
|
+
Use this scaffold when a target repository should keep AGDF state outside chat history and tool memory.
|
|
6
|
+
|
|
7
|
+
## Files
|
|
8
|
+
|
|
9
|
+
| File | Purpose |
|
|
10
|
+
|---|---|
|
|
11
|
+
| `templates/AGDF_RUN.md` | Current run state: mode, gate, approvals, evidence, risks, next allowed action |
|
|
12
|
+
| `templates/MASTER_BACKLOG.md` | Living backlog pointer: active initiatives and current UR/PRD/SD/TP artefacts |
|
|
13
|
+
| `templates/SOT_REGISTRY.md` | Source-of-truth registry: one primary owner per domain |
|
|
14
|
+
| `templates/CONTEXT_GRAPH.md` | Project memory: durable decisions, Brownfield findings, risks, evidence and exit criteria |
|
|
15
|
+
| `templates/AGENT_QUALITY_CONTRACTS.json` | Machine-readable warning, revise and block contracts for review and QA |
|
|
16
|
+
|
|
17
|
+
## Recommended Target Layout
|
|
18
|
+
|
|
19
|
+
```text
|
|
20
|
+
.agdf/
|
|
21
|
+
control/
|
|
22
|
+
AGDF_RUN.md
|
|
23
|
+
MASTER_BACKLOG.md
|
|
24
|
+
SOT_REGISTRY.md
|
|
25
|
+
CONTEXT_GRAPH.md
|
|
26
|
+
AGENT_QUALITY_CONTRACTS.json
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Keep these files small and reviewable. They are control artefacts, not a second documentation site.
|
|
30
|
+
|
|
31
|
+
## Operating Rules
|
|
32
|
+
|
|
33
|
+
- `AGDF_RUN.md` is the current run dashboard.
|
|
34
|
+
- `MASTER_BACKLOG.md` points to active delivery work; detailed artefacts live beside the work item.
|
|
35
|
+
- `SOT_REGISTRY.md` decides which document owns which domain.
|
|
36
|
+
- `CONTEXT_GRAPH.md` records durable project knowledge only when it has evidence and an exit criterion.
|
|
37
|
+
- `AGENT_QUALITY_CONTRACTS.json` names reusable block, revise and warning conditions.
|
|
38
|
+
|
|
39
|
+
Do not duplicate full product documentation in this scaffold. Link to the authoritative artefact instead.
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# AGDF Run State
|
|
2
|
+
|
|
3
|
+
## Run Meta
|
|
4
|
+
|
|
5
|
+
- run_id:
|
|
6
|
+
- started_at:
|
|
7
|
+
- mode: `quick_task | structured_delivery`
|
|
8
|
+
- current_gate: `none | UR | PRD | SD | TP | CD+Tests | CR | QA | UAT | OR`
|
|
9
|
+
- decision: `pass | revise | block | in_progress`
|
|
10
|
+
- owner:
|
|
11
|
+
|
|
12
|
+
## Objective
|
|
13
|
+
|
|
14
|
+
What outcome is this run trying to make trustworthy?
|
|
15
|
+
|
|
16
|
+
## Current Control State
|
|
17
|
+
|
|
18
|
+
| Question | Answer |
|
|
19
|
+
|---|---|
|
|
20
|
+
| What is known? | |
|
|
21
|
+
| What is approved? | |
|
|
22
|
+
| What is missing? | |
|
|
23
|
+
| What is the next allowed action? | |
|
|
24
|
+
| What is explicitly forbidden right now? | |
|
|
25
|
+
|
|
26
|
+
## Approvals
|
|
27
|
+
|
|
28
|
+
Valid approval format for new runs: `Approval: <GateName>`.
|
|
29
|
+
|
|
30
|
+
| Gate | Status | Evidence |
|
|
31
|
+
|---|---|---|
|
|
32
|
+
| UR | `missing | approved | not_applicable` | |
|
|
33
|
+
| PRD | `missing | approved | not_applicable` | |
|
|
34
|
+
| SD | `missing | approved | not_applicable` | |
|
|
35
|
+
| TP | `missing | approved | not_applicable` | |
|
|
36
|
+
| QA | `missing | approved | not_applicable` | |
|
|
37
|
+
| UAT | `missing | approved | not_applicable` | |
|
|
38
|
+
|
|
39
|
+
## Artefacts
|
|
40
|
+
|
|
41
|
+
| Type | Path | Status | Notes |
|
|
42
|
+
|---|---|---|---|
|
|
43
|
+
| UR | | `draft | approved | superseded | not_applicable` | |
|
|
44
|
+
| PRD | | `draft | approved | superseded | not_applicable` | |
|
|
45
|
+
| SD | | `draft | approved | superseded | not_applicable` | |
|
|
46
|
+
| TP | | `draft | approved | superseded | not_applicable` | |
|
|
47
|
+
| Review | | `missing | done | not_applicable` | |
|
|
48
|
+
| QA | | `missing | pass | revise | block | not_applicable` | |
|
|
49
|
+
| OR | | `missing | done | not_applicable` | |
|
|
50
|
+
|
|
51
|
+
## Evidence
|
|
52
|
+
|
|
53
|
+
| Evidence | Source | Covers | Strength |
|
|
54
|
+
|---|---|---|---|
|
|
55
|
+
| | | | `direct | indirect | weak` |
|
|
56
|
+
|
|
57
|
+
## Missing Evidence
|
|
58
|
+
|
|
59
|
+
| Missing evidence | Impact | Required next step |
|
|
60
|
+
|---|---|---|
|
|
61
|
+
| | `warn | revise | block` | |
|
|
62
|
+
|
|
63
|
+
## Risks
|
|
64
|
+
|
|
65
|
+
| Risk | Impact | Mitigation or owner |
|
|
66
|
+
|---|---|---|
|
|
67
|
+
| | `warn | revise | block` | |
|
|
68
|
+
|
|
69
|
+
## Context Graph Impact
|
|
70
|
+
|
|
71
|
+
- context_graph_impact: `none | link_only | update_existing_node | new_node_required | sot_drift`
|
|
72
|
+
- context_graph_refs:
|
|
73
|
+
- context_graph_required_action: `none | link | update | create | resolve_drift`
|
|
74
|
+
- context_graph_gate_effect: `none | warning | revise | block`
|
|
75
|
+
- context_graph_evidence:
|
|
76
|
+
|
|
77
|
+
## Closeout
|
|
78
|
+
|
|
79
|
+
- delivered:
|
|
80
|
+
- not_delivered:
|
|
81
|
+
- verification_performed:
|
|
82
|
+
- unverified:
|
|
83
|
+
- next_allowed_action:
|
|
84
|
+
- quality_outlook:
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schema_version": "1",
|
|
3
|
+
"updated_at": "",
|
|
4
|
+
"contracts": [
|
|
5
|
+
{
|
|
6
|
+
"code": "AGDF_GATE_BYPASS",
|
|
7
|
+
"category": "agent_process",
|
|
8
|
+
"impact": "block",
|
|
9
|
+
"title": "Gate bypass",
|
|
10
|
+
"description": "A later artefact or implementation was produced without the required exact approval.",
|
|
11
|
+
"applies_to_modes": ["structured_delivery"],
|
|
12
|
+
"gate_effect": ["prd", "sd", "tp", "qa", "uat"],
|
|
13
|
+
"required_evidence": ["approval_log", "artifact_status"],
|
|
14
|
+
"evaluation": "review",
|
|
15
|
+
"owner": "governance"
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"code": "AGDF_QA_WITHOUT_TASK_PLAN_REVIEW",
|
|
19
|
+
"category": "agent_process",
|
|
20
|
+
"impact": "block",
|
|
21
|
+
"title": "QA without task-plan review",
|
|
22
|
+
"description": "QA is evaluated for Structured Delivery without prior task-plan coverage evidence.",
|
|
23
|
+
"applies_to_modes": ["structured_delivery"],
|
|
24
|
+
"gate_effect": ["qa"],
|
|
25
|
+
"required_evidence": ["task_plan_review"],
|
|
26
|
+
"evaluation": "review",
|
|
27
|
+
"owner": "governance"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"code": "AGDF_PARALLEL_SOT",
|
|
31
|
+
"category": "architecture_integrity",
|
|
32
|
+
"impact": "block",
|
|
33
|
+
"title": "Parallel source of truth",
|
|
34
|
+
"description": "A second source of truth was introduced for product intent, runtime behavior, visible state, policy or persistent domain data.",
|
|
35
|
+
"applies_to_modes": ["structured_delivery", "quick_task"],
|
|
36
|
+
"gate_effect": ["prd", "sd", "tp", "qa"],
|
|
37
|
+
"required_evidence": ["brownfield_analysis", "source_of_truth_reference"],
|
|
38
|
+
"evaluation": "review",
|
|
39
|
+
"owner": "governance"
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"code": "AGDF_DOC_IMPACT_UNCHECKED",
|
|
43
|
+
"category": "doc_spec_drift",
|
|
44
|
+
"impact": "revise",
|
|
45
|
+
"title": "Documentation or SoT impact unchecked",
|
|
46
|
+
"description": "A behavior, architecture, API, UX, policy or runtime change was completed without checking the affected source-of-truth artefacts.",
|
|
47
|
+
"applies_to_modes": ["structured_delivery", "quick_task"],
|
|
48
|
+
"gate_effect": ["qa"],
|
|
49
|
+
"required_evidence": ["sot_impact_review"],
|
|
50
|
+
"evaluation": "review",
|
|
51
|
+
"owner": "docs"
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"code": "AGDF_TEST_SCOPE_UNCLEAR",
|
|
55
|
+
"category": "tp_coverage",
|
|
56
|
+
"impact": "revise",
|
|
57
|
+
"title": "Test scope unclear",
|
|
58
|
+
"description": "Tests were cited but are not traceable to affected acceptance criteria, tasks or risk paths.",
|
|
59
|
+
"applies_to_modes": ["structured_delivery", "quick_task"],
|
|
60
|
+
"gate_effect": ["qa"],
|
|
61
|
+
"required_evidence": ["test_result", "acceptance_mapping"],
|
|
62
|
+
"evaluation": "review",
|
|
63
|
+
"owner": "test"
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"code": "AGDF_QUICK_TASK_EVIDENCE_LIGHT",
|
|
67
|
+
"category": "agent_process",
|
|
68
|
+
"impact": "warn",
|
|
69
|
+
"title": "Quick task evidence light",
|
|
70
|
+
"description": "A Quick Task has minimal evidence that may be acceptable for scope and risk but must remain visible.",
|
|
71
|
+
"applies_to_modes": ["quick_task"],
|
|
72
|
+
"gate_effect": ["none"],
|
|
73
|
+
"required_evidence": ["closeout_note"],
|
|
74
|
+
"evaluation": "review",
|
|
75
|
+
"owner": "governance"
|
|
76
|
+
}
|
|
77
|
+
]
|
|
78
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# AGDF Context Graph
|
|
2
|
+
|
|
3
|
+
This file keeps durable delivery knowledge discoverable. It is not a second PRD, SD or task plan.
|
|
4
|
+
|
|
5
|
+
## Admission Rules
|
|
6
|
+
|
|
7
|
+
A node belongs here only when it has:
|
|
8
|
+
|
|
9
|
+
- concrete evidence
|
|
10
|
+
- affected artefacts or paths
|
|
11
|
+
- a visible risk, decision, invariant or reusable Brownfield finding
|
|
12
|
+
- a next clean step
|
|
13
|
+
- an exit criterion
|
|
14
|
+
|
|
15
|
+
Do not add nodes for general opinions, one-off chat summaries or local observations without future decision value.
|
|
16
|
+
|
|
17
|
+
## Node Index
|
|
18
|
+
|
|
19
|
+
| ID | Type | Status | Title | Evidence | Next Step |
|
|
20
|
+
|---|---|---|---|---|---|
|
|
21
|
+
| CG-001 | `decision | brownfield_finding | quality_node | sot_invariant | cleanup_obligation | integration_surface` | `draft | active | resolved | superseded | rejected` | | | |
|
|
22
|
+
|
|
23
|
+
## Relationship Language
|
|
24
|
+
|
|
25
|
+
| Relationship | Meaning |
|
|
26
|
+
|---|---|
|
|
27
|
+
| `derived_from` | An artefact was derived from another artefact |
|
|
28
|
+
| `satisfies` | A task or implementation satisfies a requirement or acceptance criterion |
|
|
29
|
+
| `tests` | A test checks a criterion or risk |
|
|
30
|
+
| `mitigates` | Evidence reduces a risk |
|
|
31
|
+
| `depends_on` | A decision or artefact depends on another |
|
|
32
|
+
| `changes` | A requirement changes a component, artefact or behavior |
|
|
33
|
+
| `supersedes` | A newer artefact replaces an older basis |
|
|
34
|
+
| `blocks` | A defect or risk blocks a gate |
|
|
35
|
+
| `approved_by` | An artefact was approved by a gate |
|
|
36
|
+
| `evidenced_by` | A claim is backed by evidence |
|
|
37
|
+
|
|
38
|
+
## Nodes
|
|
39
|
+
|
|
40
|
+
### CG-001 Example
|
|
41
|
+
|
|
42
|
+
- type:
|
|
43
|
+
- status:
|
|
44
|
+
- title:
|
|
45
|
+
- introduced_by:
|
|
46
|
+
- affects:
|
|
47
|
+
- evidence:
|
|
48
|
+
- risk_or_value:
|
|
49
|
+
- next_clean_step:
|
|
50
|
+
- exit_criterion:
|
|
51
|
+
- links:
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# AGDF Master Backlog
|
|
2
|
+
|
|
3
|
+
This file is the living control pointer for active AGDF delivery work. Detailed UR, PRD, SD, TP, QA and OR artefacts should live in stable paths and be linked from here.
|
|
4
|
+
|
|
5
|
+
## Rules
|
|
6
|
+
|
|
7
|
+
1. Keep only steering-relevant work in `Active Backlog`.
|
|
8
|
+
2. Every active item has exactly one current spec pointer.
|
|
9
|
+
3. Historical artefacts remain linkable but do not override the current pointer.
|
|
10
|
+
4. If an item is superseded, mark the replacement.
|
|
11
|
+
5. If active work grows beyond roughly ten items, triage the backlog.
|
|
12
|
+
|
|
13
|
+
## Active Backlog
|
|
14
|
+
|
|
15
|
+
| Prio | Key | Title | Status | Current Spec | Notes |
|
|
16
|
+
|---:|---|---|---|---|---|
|
|
17
|
+
| P1 | | | `in_progress | blocked` | | |
|
|
18
|
+
|
|
19
|
+
## Planned / Parking Lot
|
|
20
|
+
|
|
21
|
+
| Prio | Key | Title | Status | Current Spec | Notes |
|
|
22
|
+
|---:|---|---|---|---|---|
|
|
23
|
+
| P2 | | | `planned | review_needed` | | |
|
|
24
|
+
|
|
25
|
+
## Completed / Superseded Pointers
|
|
26
|
+
|
|
27
|
+
| Key | Title | Final Status | Current or Historical Link | Notes |
|
|
28
|
+
|---|---|---|---|---|
|
|
29
|
+
| | | `done | superseded | abandoned` | | |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AGDF Source-of-Truth Registry
|
|
2
|
+
|
|
3
|
+
Use this file to prevent parallel sources of truth. Each domain should have one primary owner.
|
|
4
|
+
|
|
5
|
+
## Primary Sources of Truth
|
|
6
|
+
|
|
7
|
+
| Domain | SoT Document | Status | Owner | Last Verified |
|
|
8
|
+
|---|---|---|---|---|
|
|
9
|
+
| Product intent | | `active | draft | superseded` | | |
|
|
10
|
+
| Architecture | | `active | draft | superseded` | | |
|
|
11
|
+
| Runtime contracts | | `active | draft | superseded` | | |
|
|
12
|
+
| UX / user flows | | `active | draft | superseded` | | |
|
|
13
|
+
| Operations / release | | `active | draft | superseded` | | |
|
|
14
|
+
|
|
15
|
+
## Secondary References
|
|
16
|
+
|
|
17
|
+
Secondary references may support decisions, but they do not override the primary SoT.
|
|
18
|
+
|
|
19
|
+
| Reference | Purpose | Limit |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| | | |
|
|
22
|
+
|
|
23
|
+
## Conflict Rule
|
|
24
|
+
|
|
25
|
+
When a secondary document, generated output, old snapshot or chat summary conflicts with the primary SoT, the primary SoT wins until a new approved artefact changes it.
|
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# AGDF repository skills
|
|
2
2
|
|
|
3
|
-
These repository skills
|
|
3
|
+
These repository skills were generated from the AGDF source repository and are intended to be checked into this repository.
|
|
4
4
|
|
|
5
5
|
## Skills
|
|
6
6
|
|
|
7
7
|
- `agdf-brownfield-analysis`
|
|
8
8
|
- `agdf-clean-implementation-review`
|
|
9
|
+
- `agdf-code-review`
|
|
9
10
|
- `agdf-delivery-closeout`
|
|
10
11
|
- `agdf-gate-check`
|
|
11
12
|
- `agdf-qa-gate`
|
|
@@ -14,4 +15,4 @@ These repository skills are generated from `plugin/skills/`, which is the single
|
|
|
14
15
|
|
|
15
16
|
## Runtime contract
|
|
16
17
|
|
|
17
|
-
Shared output and gate rules live in `agdf-runtime-contract.md`.
|
|
18
|
+
Shared output and gate rules for this checkout live in `agdf-runtime-contract.md`.
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: agdf-code-review
|
|
3
|
+
description: Use this skill after code changes and before QA to produce the mandatory Code Review Report for correctness, regression, security, and maintainability findings in the actual diff. It standardizes the CR step without replacing TP review, clean review, or QA.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# code-review
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Produce the mandatory Code Review Report (CR) for a relevant run.
|
|
10
|
+
|
|
11
|
+
It answers:
|
|
12
|
+
|
|
13
|
+
- whether the changed code shows functional defects, security issues, regression risks, or maintainability problems that matter
|
|
14
|
+
- whether findings are blocking, revisable, or advisory
|
|
15
|
+
- which concrete evidence in files, diffs, tests, or runtime observations supports each finding
|
|
16
|
+
- which issues must be fixed before QA
|
|
17
|
+
- whether Brownfield, TP, or clean-review follow-up remains open
|
|
18
|
+
|
|
19
|
+
## Runtime Contract
|
|
20
|
+
Use `../agdf-runtime-contract.md` for Quality Contract output, Context Graph fields, gate terms, and non-duplication rules.
|
|
21
|
+
|
|
22
|
+
Code-review-specific output must make actual findings, missing review scope, evidence strength, and the next required step visible.
|
|
23
|
+
|
|
24
|
+
## Rules
|
|
25
|
+
1. Review the actual diff and impacted code, not intent alone.
|
|
26
|
+
2. Findings require concrete evidence.
|
|
27
|
+
3. Prioritize correctness, safety, data integrity, compatibility, and maintainability over style.
|
|
28
|
+
4. Do not generate style-only noise.
|
|
29
|
+
5. Missing review scope or evidence must stay visible.
|
|
30
|
+
6. Brownfield owners and existing conventions are binding unless deviation is justified.
|
|
31
|
+
7. Distinguish blocking defects from fixable review findings.
|
|
32
|
+
8. CR does not grant QA pass.
|
|
33
|
+
|
|
34
|
+
## When To Use
|
|
35
|
+
- after `CD+Tests`
|
|
36
|
+
- before `QA`
|
|
37
|
+
- when code changes exist
|
|
38
|
+
- when multiple agents or contributors touched the same area
|
|
39
|
+
- when a commit-near change needs explicit review evidence
|
|
40
|
+
|
|
41
|
+
## Inputs
|
|
42
|
+
Use what is available:
|
|
43
|
+
|
|
44
|
+
- changed files and diff
|
|
45
|
+
- affected neighbouring code
|
|
46
|
+
- test/build results
|
|
47
|
+
- Brownfield Analysis
|
|
48
|
+
- Task Plan and TP Review
|
|
49
|
+
- Clean Implementation Review
|
|
50
|
+
- runtime or UI evidence
|
|
51
|
+
- known risks or follow-up decisions
|
|
52
|
+
|
|
53
|
+
If no code changes are present, do not invent a CR result.
|
|
54
|
+
|
|
55
|
+
## Workflow
|
|
56
|
+
1. Inspect the changed files and directly impacted neighbours.
|
|
57
|
+
2. Check correctness, edge cases, and error paths.
|
|
58
|
+
3. Check security, data handling, and state ownership risks.
|
|
59
|
+
4. Check regression and compatibility risks.
|
|
60
|
+
5. Check maintainability only where it creates real defect or change-risk exposure.
|
|
61
|
+
6. Classify the overall result:
|
|
62
|
+
- `pass`
|
|
63
|
+
- `revise`
|
|
64
|
+
- `block`
|
|
65
|
+
- `not_applicable`
|
|
66
|
+
7. Set exactly one required next step.
|
|
67
|
+
|
|
68
|
+
## Output
|
|
69
|
+
Use this compact structure:
|
|
70
|
+
|
|
71
|
+
```text
|
|
72
|
+
## Code Review
|
|
73
|
+
- decision: pass | revise | block | not_applicable
|
|
74
|
+
- findings:
|
|
75
|
+
- [severity] file/path - issue - evidence
|
|
76
|
+
- missing_evidence:
|
|
77
|
+
- risks:
|
|
78
|
+
- required_next_step:
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Decision Guidance
|
|
82
|
+
- `pass`: no meaningful review finding remains evident in reviewed scope.
|
|
83
|
+
- `revise`: fixable correctness, regression, or maintainability issues remain.
|
|
84
|
+
- `block`: a hard defect, security risk, data-integrity risk, or unresolved critical uncertainty remains.
|
|
85
|
+
- `not_applicable`: no code changes were present for review.
|
|
86
|
+
|
|
87
|
+
## Forbidden
|
|
88
|
+
This skill must not:
|
|
89
|
+
|
|
90
|
+
- decide final QA
|
|
91
|
+
- accept a green build as sufficient review evidence
|
|
92
|
+
- hide missing review scope
|
|
93
|
+
- generate style-only findings
|
|
94
|
+
- duplicate TP Review or QA as if they were the same step
|
|
@@ -40,7 +40,7 @@ QA-specific `decision` is exactly `pass | revise | block`.
|
|
|
40
40
|
|
|
41
41
|
## When To Use
|
|
42
42
|
- after `CD+Tests`
|
|
43
|
-
- after
|
|
43
|
+
- after `agdf-code-review`
|
|
44
44
|
- after `agdf-task-plan-review`
|
|
45
45
|
- after `agdf-clean-implementation-review`
|
|
46
46
|
- before UAT
|
|
@@ -58,7 +58,7 @@ Use what is available:
|
|
|
58
58
|
- approved TP and TP Review
|
|
59
59
|
- Brownfield Analysis
|
|
60
60
|
- Clean Implementation Review
|
|
61
|
-
- Code Review Report
|
|
61
|
+
- `agdf-code-review` or Code Review Report
|
|
62
62
|
- test/build results
|
|
63
63
|
- documentation impact review
|
|
64
64
|
- runtime or UI evidence
|
|
@@ -46,7 +46,7 @@ OR-specific output must make gate status, delivered and intentionally not delive
|
|
|
46
46
|
- after artefact creation
|
|
47
47
|
- when a gate blocks
|
|
48
48
|
- after `CD+Tests`
|
|
49
|
-
- after
|
|
49
|
+
- after `agdf-code-review`
|
|
50
50
|
- after QA
|
|
51
51
|
- after UAT
|
|
52
52
|
- whenever a compact audit closeout is needed
|
|
@@ -62,6 +62,7 @@ Use what is available:
|
|
|
62
62
|
- `agdf-task-plan-review`
|
|
63
63
|
- `agdf-brownfield-analysis`
|
|
64
64
|
- `agdf-clean-implementation-review`
|
|
65
|
+
- `agdf-code-review`
|
|
65
66
|
- QA Report
|
|
66
67
|
- UAT Report
|
|
67
68
|
- documentation impact review
|
|
@@ -22,6 +22,7 @@ Structured Delivery must not bypass missing approvals.
|
|
|
22
22
|
- Implicit consent is not approval.
|
|
23
23
|
- The earliest blocking gate wins.
|
|
24
24
|
- `CD+Tests` is implementation and test status only, not a delivery signal.
|
|
25
|
+
- `agdf-code-review` standardizes the mandatory `CR` step, but does not replace QA.
|
|
25
26
|
- `agdf-qa-gate` decides final `pass | revise | block`.
|
|
26
27
|
- `agdf-release-or` reports the run, but does not replace QA.
|
|
27
28
|
|
|
@@ -52,6 +53,18 @@ When a run affects project memory or a Context Graph, use:
|
|
|
52
53
|
Do not create a new node for a mere version, a general chat summary, or a local observation without a concrete next clean step.
|
|
53
54
|
`sot_drift` must not pass silently as a warning.
|
|
54
55
|
|
|
56
|
+
## Control Scaffold
|
|
57
|
+
|
|
58
|
+
When a repository needs durable AGDF state, use the plugin-local `control/` scaffold as the starting point.
|
|
59
|
+
|
|
60
|
+
- `AGDF_RUN.md` is the current run dashboard.
|
|
61
|
+
- `MASTER_BACKLOG.md` is the living pointer for active delivery work.
|
|
62
|
+
- `SOT_REGISTRY.md` prevents parallel sources of truth.
|
|
63
|
+
- `CONTEXT_GRAPH.md` stores durable Brownfield findings, decisions, risks, evidence and exit criteria.
|
|
64
|
+
- `AGENT_QUALITY_CONTRACTS.json` stores reusable block, revise and warning conditions.
|
|
65
|
+
|
|
66
|
+
The scaffold is not a second documentation site. Link to authoritative artefacts instead of copying them.
|
|
67
|
+
|
|
55
68
|
## Skill Output
|
|
56
69
|
|
|
57
70
|
Every skill output should be as short as possible and as concrete as needed.
|
package/generated/AGENTS.md
CHANGED
|
@@ -44,6 +44,7 @@ Evidence overrides assumptions and memory. If evidence is missing, state the unc
|
|
|
44
44
|
| `agdf-brownfield-analysis` | before non-trivial implementation in existing systems | clarifies reuse, owners, risks |
|
|
45
45
|
| `agdf-task-plan-review` | after implementation and before QA, verify TP coverage | no final QA decision |
|
|
46
46
|
| `agdf-clean-implementation-review` | inspect workarounds, fallbacks, parallel structures, or symptom fixes | not a TP or QA substitute |
|
|
47
|
+
| `agdf-code-review` | mandatory CR step after code changes, focused on defects, regression, and security findings | does not replace TP review, clean review, or QA |
|
|
47
48
|
| `agdf-qa-gate` | final QA decision | only instance for `pass | revise | block` |
|
|
48
49
|
| `agdf-release-or` | auditable closeout for every relevant run | not a QA substitute |
|
|
49
50
|
| `agdf-delivery-closeout` | commit/PR-near handoff after QA/OR/UAT | never performs VCS actions automatically |
|
|
@@ -52,10 +53,22 @@ Select exactly one primary skill first. Add more only when they cover a distinct
|
|
|
52
53
|
|
|
53
54
|
## Skill Contract
|
|
54
55
|
For repeated output, gate, Quality Contract, and Context Graph rules, use:
|
|
55
|
-
`
|
|
56
|
+
the repository-local `agdf-runtime-contract.md` artifact.
|
|
56
57
|
|
|
57
58
|
Skills may include short runtime reminders, but must not carry a second complete rule or code table.
|
|
58
59
|
|
|
60
|
+
## Durable Control State
|
|
61
|
+
When this repository uses the AGDF control scaffold, keep live control files under `.agdf/control/`.
|
|
62
|
+
Use the templates as starting points only:
|
|
63
|
+
|
|
64
|
+
- `.agdf/control/templates/AGDF_RUN.md`
|
|
65
|
+
- `.agdf/control/templates/MASTER_BACKLOG.md`
|
|
66
|
+
- `.agdf/control/templates/SOT_REGISTRY.md`
|
|
67
|
+
- `.agdf/control/templates/CONTEXT_GRAPH.md`
|
|
68
|
+
- `.agdf/control/templates/AGENT_QUALITY_CONTRACTS.json`
|
|
69
|
+
|
|
70
|
+
Do not let chat history become the source of truth for gate state, approvals, evidence, backlog status or durable Brownfield knowledge.
|
|
71
|
+
|
|
59
72
|
## Closeout
|
|
60
73
|
After relevant code, documentation, skill, or governance changes:
|
|
61
74
|
- run relevant checks or state the test gap
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-agdf",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "Bootstrap AGDF for GitHub Copilot
|
|
3
|
+
"version": "0.1.3",
|
|
4
|
+
"description": "Bootstrap AGDF repository instructions, skills and control templates for GitHub Copilot; AGDF also ships as Claude Code and Codex plugins.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"files": [
|
|
7
7
|
"bin",
|
|
@@ -20,6 +20,8 @@
|
|
|
20
20
|
"agdf",
|
|
21
21
|
"copilot",
|
|
22
22
|
"claude-code",
|
|
23
|
+
"codex",
|
|
24
|
+
"control",
|
|
23
25
|
"scaffold",
|
|
24
26
|
"bootstrap"
|
|
25
27
|
],
|