You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/agents/adr-writer.agent.md
-62Lines changed: 0 additions & 62 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,8 +34,6 @@ docs/adr/
34
34
35
35
## ADR Template
36
36
37
-
Two parts: **human-friendly narrative**, then **RFC 2119 normative specification** for machine-checkable conformance.
38
-
39
37
```markdown
40
38
# ADR-{NNNN}: {Concise Decision Title}
41
39
@@ -45,8 +43,6 @@ Two parts: **human-friendly narrative**, then **RFC 2119 normative specification
45
43
46
44
---
47
45
48
-
## Part 1 — Narrative (Human-Friendly)
49
-
50
46
### Context
51
47
52
48
{Describe the situation, problem, and forces at play in plain language. What is the issue that motivated this decision? What constraints exist? What are the non-negotiable requirements? Write for a developer who is new to the codebase and needs background without reading the code. Keep this to 3–5 sentences.}
@@ -83,28 +79,6 @@ Two parts: **human-friendly narrative**, then **RFC 2119 normative specification
83
79
84
80
---
85
81
86
-
## Part 2 — Normative Specification (RFC 2119)
87
-
88
-
> The key words **MUST**, **MUST NOT**, **REQUIRED**, **SHALL**, **SHALL NOT**, **SHOULD**, **SHOULD NOT**, **RECOMMENDED**, **MAY**, and **OPTIONAL** in this section are to be interpreted as described in [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119).
1. Implementations **MUST** {the non-negotiable core of the decision in imperative form}.
93
-
2. Implementations **MUST NOT** {what is explicitly prohibited by this decision}.
94
-
3. Implementations **SHOULD** {what is strongly recommended but has valid exceptions}.
95
-
4. Implementations **MAY** {what is permitted but not required}.
96
-
97
-
### {Secondary requirement area, if applicable}
98
-
99
-
1. {Additional normative requirement}.
100
-
2. {Additional normative requirement}.
101
-
102
-
### Conformance
103
-
104
-
An implementation is considered conformant with this ADR if it satisfies all **MUST** and **MUST NOT** requirements above. Failure to meet any **MUST** or **MUST NOT** requirement constitutes non-conformance.
105
-
106
-
---
107
-
108
82
*ADR created by [adr-writer agent]. Review and finalize before changing status from Draft to Accepted.*
109
83
```
110
84
@@ -120,8 +94,6 @@ An implementation is considered conformant with this ADR if it satisfies all **M
120
94
121
95
## Writing Quality Standards
122
96
123
-
### Part 1 — Narrative Sections
124
-
125
97
#### Context (3–5 sentences)
126
98
-*What problem? What constraints?* (technical, organizational, timeline)
127
99
- Codebase state at decision time
@@ -143,31 +115,6 @@ An implementation is considered conformant with this ADR if it satisfies all **M
143
115
-**Neutral**: side effects worth noting
144
116
- ≥2 per category for non-trivial decisions
145
117
146
-
### Part 2 — Normative Specification
147
-
148
-
Translates the Decision into testable [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119) requirements.
0 commit comments