Skip to content

Commit 77dbced

Browse files
committed
feat(docs): add Architecture Decision Records (ADR) guidelines to documentation
1 parent a670285 commit 77dbced

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

.github/copilot-instructions.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,28 @@ After any source code change:
1818
3. [ ] Repeat until both commands complete with zero errors and zero warnings
1919
4. [ ] Do this automatically without prompting
2020

21+
## Documentation (Mandatory)
22+
23+
When making architectural or significant technical decisions, document them as Architecture Decision Records (ADRs):
24+
25+
**What requires an ADR:**
26+
27+
- [ ] Architectural style choices (e.g. event-driven vs layered, monolith vs microservices)
28+
- [ ] Architectural pattern choices (e.g. composition over inheritance, repository pattern)
29+
- [ ] Language and framework selections
30+
- [ ] Any other significant technical decision that shapes the system
31+
32+
**ADR requirements:**
33+
34+
- [ ] Use the template at [docs/adr/adr-template.md](../docs/adr/adr-template.md)
35+
- [ ] Follow the existing ADR format for consistency
36+
- [ ] Always present 3 or more options with trade-offs
37+
- [ ] Include the conversational context that led to the decision
38+
- [ ] Document decisions regardless of whether you made them independently or were guided by the user
39+
40+
This requirement is mandatory, especially during the spec-driven development cycle: `spec``plan``tasks``implement`.
41+
2142
---
2243

23-
> **Version**: 1.2.1
24-
> **Last Amended**: 2026-01-13
44+
> **Version**: 1.3.0
45+
> **Last Amended**: 2026-01-18

0 commit comments

Comments
 (0)