create-universal-ai-context 2.4.0 → 2.6.0-final

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.
Files changed (153) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +331 -294
  3. package/bin/create-ai-context.js +1507 -764
  4. package/lib/adapters/aider.js +131 -131
  5. package/lib/adapters/antigravity.js +205 -205
  6. package/lib/adapters/claude.js +397 -397
  7. package/lib/adapters/cline.js +125 -125
  8. package/lib/adapters/continue.js +138 -138
  9. package/lib/adapters/copilot.js +131 -131
  10. package/lib/adapters/index.js +78 -78
  11. package/lib/adapters/windsurf.js +138 -138
  12. package/lib/ai-context-generator.js +234 -234
  13. package/lib/ai-orchestrator.js +432 -432
  14. package/lib/call-tracer.js +444 -444
  15. package/lib/content-preservation.js +243 -243
  16. package/lib/cross-tool-sync/file-watcher.js +274 -274
  17. package/lib/cross-tool-sync/index.js +41 -40
  18. package/lib/cross-tool-sync/sync-manager.js +540 -512
  19. package/lib/cross-tool-sync/sync-service.js +297 -297
  20. package/lib/detector.js +726 -726
  21. package/lib/doc-discovery.js +741 -741
  22. package/lib/drift-checker.js +920 -920
  23. package/lib/environment-detector.js +239 -239
  24. package/lib/index.js +399 -399
  25. package/lib/install-hooks.js +82 -82
  26. package/lib/installer.js +419 -419
  27. package/lib/migrate.js +328 -328
  28. package/lib/placeholder.js +632 -632
  29. package/lib/prompts.js +341 -341
  30. package/lib/smart-merge.js +540 -540
  31. package/lib/spinner.js +60 -60
  32. package/lib/static-analyzer.js +729 -729
  33. package/lib/template-coordination.js +148 -148
  34. package/lib/template-populator.js +843 -843
  35. package/lib/template-renderer.js +392 -392
  36. package/lib/utils/fs-wrapper.js +79 -79
  37. package/lib/utils/path-utils.js +60 -60
  38. package/lib/validate.js +155 -155
  39. package/package.json +1 -1
  40. package/templates/AI_CONTEXT.md.template +245 -245
  41. package/templates/base/README.md +260 -257
  42. package/templates/base/RPI_WORKFLOW_PLAN.md +325 -320
  43. package/templates/base/agents/api-developer.md +76 -76
  44. package/templates/base/agents/context-engineer.md +525 -525
  45. package/templates/base/agents/core-architect.md +76 -76
  46. package/templates/base/agents/database-ops.md +76 -76
  47. package/templates/base/agents/deployment-ops.md +76 -76
  48. package/templates/base/agents/integration-hub.md +76 -76
  49. package/templates/base/analytics/README.md +114 -114
  50. package/templates/base/automation/config.json +58 -58
  51. package/templates/base/automation/generators/code-mapper.js +308 -308
  52. package/templates/base/automation/generators/index-builder.js +321 -321
  53. package/templates/base/automation/hooks/post-commit.sh +83 -83
  54. package/templates/base/automation/hooks/pre-commit.sh +103 -103
  55. package/templates/base/ci-templates/README.md +108 -108
  56. package/templates/base/ci-templates/github-actions/context-check.yml +144 -144
  57. package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -105
  58. package/templates/base/commands/analytics.md +238 -238
  59. package/templates/base/commands/auto-sync.md +172 -172
  60. package/templates/base/commands/collab.md +194 -194
  61. package/templates/base/commands/context-optimize.md +226 -0
  62. package/templates/base/commands/help.md +485 -450
  63. package/templates/base/commands/rpi-implement.md +164 -115
  64. package/templates/base/commands/rpi-plan.md +147 -93
  65. package/templates/base/commands/rpi-research.md +145 -88
  66. package/templates/base/commands/session-resume.md +144 -144
  67. package/templates/base/commands/session-save.md +112 -112
  68. package/templates/base/commands/validate-all.md +77 -77
  69. package/templates/base/commands/verify-docs-current.md +86 -86
  70. package/templates/base/config/base.json +57 -57
  71. package/templates/base/config/environments/development.json +13 -13
  72. package/templates/base/config/environments/production.json +17 -17
  73. package/templates/base/config/environments/staging.json +13 -13
  74. package/templates/base/config/local.json.example +21 -21
  75. package/templates/base/context/.meta/generated-at.json +18 -18
  76. package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -156
  77. package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -94
  78. package/templates/base/context/FILE_OWNERSHIP.md +57 -57
  79. package/templates/base/context/INTEGRATION_POINTS.md +92 -92
  80. package/templates/base/context/KNOWN_GOTCHAS.md +195 -195
  81. package/templates/base/context/TESTING_MAP.md +95 -95
  82. package/templates/base/context/WORKFLOW_INDEX.md +129 -129
  83. package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -294
  84. package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -255
  85. package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -44
  86. package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -38
  87. package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -39
  88. package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -39
  89. package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -38
  90. package/templates/base/knowledge/README.md +98 -98
  91. package/templates/base/knowledge/sessions/README.md +88 -88
  92. package/templates/base/knowledge/sessions/TEMPLATE.md +150 -150
  93. package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -144
  94. package/templates/base/knowledge/shared/decisions/README.md +49 -49
  95. package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -123
  96. package/templates/base/knowledge/shared/patterns/README.md +62 -62
  97. package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -120
  98. package/templates/base/plans/PLAN_TEMPLATE.md +316 -250
  99. package/templates/base/research/RESEARCH_TEMPLATE.md +245 -153
  100. package/templates/base/schemas/agent.schema.json +141 -141
  101. package/templates/base/schemas/anchors.schema.json +54 -54
  102. package/templates/base/schemas/automation.schema.json +93 -93
  103. package/templates/base/schemas/command.schema.json +134 -134
  104. package/templates/base/schemas/hashes.schema.json +40 -40
  105. package/templates/base/schemas/manifest.schema.json +117 -117
  106. package/templates/base/schemas/plan.schema.json +136 -136
  107. package/templates/base/schemas/research.schema.json +115 -115
  108. package/templates/base/schemas/roles.schema.json +34 -34
  109. package/templates/base/schemas/session.schema.json +77 -77
  110. package/templates/base/schemas/settings.schema.json +244 -244
  111. package/templates/base/schemas/staleness.schema.json +53 -53
  112. package/templates/base/schemas/team-config.schema.json +42 -42
  113. package/templates/base/schemas/workflow.schema.json +126 -126
  114. package/templates/base/session/checkpoints/.gitkeep +2 -2
  115. package/templates/base/session/current/state.json +20 -20
  116. package/templates/base/session/history/.gitkeep +2 -2
  117. package/templates/base/settings.json +3 -3
  118. package/templates/base/standards/COMPATIBILITY.md +219 -219
  119. package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -280
  120. package/templates/base/standards/QUALITY_CHECKLIST.md +211 -211
  121. package/templates/base/standards/README.md +66 -66
  122. package/templates/base/sync/anchors.json +6 -6
  123. package/templates/base/sync/hashes.json +6 -6
  124. package/templates/base/sync/staleness.json +10 -10
  125. package/templates/base/team/README.md +168 -168
  126. package/templates/base/team/config.json +79 -79
  127. package/templates/base/team/roles.json +145 -145
  128. package/templates/base/tools/bin/claude-context.js +151 -151
  129. package/templates/base/tools/lib/anchor-resolver.js +276 -276
  130. package/templates/base/tools/lib/config-loader.js +363 -363
  131. package/templates/base/tools/lib/detector.js +350 -350
  132. package/templates/base/tools/lib/diagnose.js +206 -206
  133. package/templates/base/tools/lib/drift-detector.js +373 -373
  134. package/templates/base/tools/lib/errors.js +199 -199
  135. package/templates/base/tools/lib/index.js +36 -36
  136. package/templates/base/tools/lib/init.js +192 -192
  137. package/templates/base/tools/lib/logger.js +230 -230
  138. package/templates/base/tools/lib/placeholder.js +201 -201
  139. package/templates/base/tools/lib/session-manager.js +354 -354
  140. package/templates/base/tools/lib/validate.js +521 -521
  141. package/templates/base/tools/package.json +49 -49
  142. package/templates/handlebars/aider-config.hbs +146 -80
  143. package/templates/handlebars/antigravity.hbs +377 -377
  144. package/templates/handlebars/claude.hbs +183 -183
  145. package/templates/handlebars/cline.hbs +62 -62
  146. package/templates/handlebars/continue-config.hbs +116 -116
  147. package/templates/handlebars/copilot.hbs +130 -130
  148. package/templates/handlebars/partials/gotcha-list.hbs +11 -11
  149. package/templates/handlebars/partials/header.hbs +3 -3
  150. package/templates/handlebars/partials/workflow-summary.hbs +16 -16
  151. package/templates/handlebars/windsurf-rules.hbs +69 -69
  152. package/templates/hooks/post-commit.hbs +28 -29
  153. package/templates/hooks/pre-commit.hbs +46 -46
@@ -1,123 +1,123 @@
1
- # ADR-NNNN: Title
2
-
3
- ## Metadata
4
-
5
- | Field | Value |
6
- |-------|-------|
7
- | **Status** | proposed / accepted / deprecated / rejected |
8
- | **Created** | YYYY-MM-DD |
9
- | **Updated** | YYYY-MM-DD |
10
- | **Author** | {{AUTHOR_NAME}} |
11
- | **Reviewers** | {{REVIEWER_NAMES}} |
12
- | **Supersedes** | ADR-XXXX (if applicable) |
13
- | **Superseded by** | ADR-XXXX (if applicable) |
14
-
15
- ## Context
16
-
17
- Describe the context and problem statement. What is the issue that we're seeing that is motivating this decision or change?
18
-
19
- ### Background
20
-
21
- - Relevant technical background
22
- - Business requirements driving this decision
23
- - Constraints we must work within
24
-
25
- ### Current State
26
-
27
- Describe the current situation, if applicable.
28
-
29
- ## Decision
30
-
31
- Describe the change that we're proposing or have made.
32
-
33
- ### Key Points
34
-
35
- 1. Point 1
36
- 2. Point 2
37
- 3. Point 3
38
-
39
- ## Alternatives Considered
40
-
41
- ### Alternative 1: [Name]
42
-
43
- **Description:** Brief description
44
-
45
- **Pros:**
46
- - Pro 1
47
- - Pro 2
48
-
49
- **Cons:**
50
- - Con 1
51
- - Con 2
52
-
53
- **Why not chosen:** Explanation
54
-
55
- ### Alternative 2: [Name]
56
-
57
- **Description:** Brief description
58
-
59
- **Pros:**
60
- - Pro 1
61
- - Pro 2
62
-
63
- **Cons:**
64
- - Con 1
65
- - Con 2
66
-
67
- **Why not chosen:** Explanation
68
-
69
- ## Consequences
70
-
71
- ### Positive
72
-
73
- - Positive consequence 1
74
- - Positive consequence 2
75
-
76
- ### Negative
77
-
78
- - Negative consequence 1
79
- - Negative consequence 2
80
-
81
- ### Risks
82
-
83
- - Risk 1 and mitigation
84
- - Risk 2 and mitigation
85
-
86
- ## Implementation
87
-
88
- ### Steps
89
-
90
- 1. Step 1
91
- 2. Step 2
92
- 3. Step 3
93
-
94
- ### Affected Components
95
-
96
- - Component 1: How it's affected
97
- - Component 2: How it's affected
98
-
99
- ### Migration Plan
100
-
101
- Describe any migration required, if applicable.
102
-
103
- ## Verification
104
-
105
- How will we verify this decision is successful?
106
-
107
- - [ ] Verification criteria 1
108
- - [ ] Verification criteria 2
109
- - [ ] Verification criteria 3
110
-
111
- ## References
112
-
113
- - [Link to relevant documentation]()
114
- - [Link to related issue/PR]()
115
- - [Link to external resources]()
116
-
117
- ---
118
-
119
- ## Revision History
120
-
121
- | Date | Author | Changes |
122
- |------|--------|---------|
123
- | YYYY-MM-DD | Name | Initial draft |
1
+ # ADR-NNNN: Title
2
+
3
+ ## Metadata
4
+
5
+ | Field | Value |
6
+ |-------|-------|
7
+ | **Status** | proposed / accepted / deprecated / rejected |
8
+ | **Created** | YYYY-MM-DD |
9
+ | **Updated** | YYYY-MM-DD |
10
+ | **Author** | {{AUTHOR_NAME}} |
11
+ | **Reviewers** | {{REVIEWER_NAMES}} |
12
+ | **Supersedes** | ADR-XXXX (if applicable) |
13
+ | **Superseded by** | ADR-XXXX (if applicable) |
14
+
15
+ ## Context
16
+
17
+ Describe the context and problem statement. What is the issue that we're seeing that is motivating this decision or change?
18
+
19
+ ### Background
20
+
21
+ - Relevant technical background
22
+ - Business requirements driving this decision
23
+ - Constraints we must work within
24
+
25
+ ### Current State
26
+
27
+ Describe the current situation, if applicable.
28
+
29
+ ## Decision
30
+
31
+ Describe the change that we're proposing or have made.
32
+
33
+ ### Key Points
34
+
35
+ 1. Point 1
36
+ 2. Point 2
37
+ 3. Point 3
38
+
39
+ ## Alternatives Considered
40
+
41
+ ### Alternative 1: [Name]
42
+
43
+ **Description:** Brief description
44
+
45
+ **Pros:**
46
+ - Pro 1
47
+ - Pro 2
48
+
49
+ **Cons:**
50
+ - Con 1
51
+ - Con 2
52
+
53
+ **Why not chosen:** Explanation
54
+
55
+ ### Alternative 2: [Name]
56
+
57
+ **Description:** Brief description
58
+
59
+ **Pros:**
60
+ - Pro 1
61
+ - Pro 2
62
+
63
+ **Cons:**
64
+ - Con 1
65
+ - Con 2
66
+
67
+ **Why not chosen:** Explanation
68
+
69
+ ## Consequences
70
+
71
+ ### Positive
72
+
73
+ - Positive consequence 1
74
+ - Positive consequence 2
75
+
76
+ ### Negative
77
+
78
+ - Negative consequence 1
79
+ - Negative consequence 2
80
+
81
+ ### Risks
82
+
83
+ - Risk 1 and mitigation
84
+ - Risk 2 and mitigation
85
+
86
+ ## Implementation
87
+
88
+ ### Steps
89
+
90
+ 1. Step 1
91
+ 2. Step 2
92
+ 3. Step 3
93
+
94
+ ### Affected Components
95
+
96
+ - Component 1: How it's affected
97
+ - Component 2: How it's affected
98
+
99
+ ### Migration Plan
100
+
101
+ Describe any migration required, if applicable.
102
+
103
+ ## Verification
104
+
105
+ How will we verify this decision is successful?
106
+
107
+ - [ ] Verification criteria 1
108
+ - [ ] Verification criteria 2
109
+ - [ ] Verification criteria 3
110
+
111
+ ## References
112
+
113
+ - [Link to relevant documentation]()
114
+ - [Link to related issue/PR]()
115
+ - [Link to external resources]()
116
+
117
+ ---
118
+
119
+ ## Revision History
120
+
121
+ | Date | Author | Changes |
122
+ |------|--------|---------|
123
+ | YYYY-MM-DD | Name | Initial draft |
@@ -1,62 +1,62 @@
1
- # Reusable Patterns
2
-
3
- This directory contains proven solutions to common problems encountered in the codebase.
4
-
5
- ## Categories
6
-
7
- | Category | Description |
8
- |----------|-------------|
9
- | `api/` | API design and implementation patterns |
10
- | `data/` | Data handling, validation, transformation |
11
- | `ui/` | User interface components and interactions |
12
- | `testing/` | Testing strategies and patterns |
13
- | `security/` | Security implementation patterns |
14
- | `performance/` | Performance optimization patterns |
15
-
16
- ## Pattern Template
17
-
18
- Each pattern document should include:
19
-
20
- ```markdown
21
- # Pattern Name
22
-
23
- ## Problem
24
- What problem does this pattern solve?
25
-
26
- ## Context
27
- When should this pattern be applied?
28
-
29
- ## Solution
30
- How does the pattern work?
31
-
32
- ## Code Example
33
- Concrete implementation example.
34
-
35
- ## Consequences
36
- Trade-offs and considerations.
37
-
38
- ## Related Patterns
39
- Links to related patterns.
40
- ```
41
-
42
- ## Adding a Pattern
43
-
44
- 1. Identify a recurring problem with a proven solution
45
- 2. Create document in appropriate category
46
- 3. Follow the template structure
47
- 4. Include working code examples
48
- 5. Reference actual codebase usage
49
-
50
- ## Using Patterns
51
-
52
- 1. Identify the problem you're solving
53
- 2. Check relevant category for existing patterns
54
- 3. Adapt the pattern to your specific context
55
- 4. Reference the pattern in your implementation
56
-
57
- ## Pattern Quality Criteria
58
-
59
- - **Proven**: Used successfully in production
60
- - **Documented**: Clear explanation and examples
61
- - **Maintained**: Updated when implementation changes
62
- - **Reviewed**: Approved by team lead or senior developer
1
+ # Reusable Patterns
2
+
3
+ This directory contains proven solutions to common problems encountered in the codebase.
4
+
5
+ ## Categories
6
+
7
+ | Category | Description |
8
+ |----------|-------------|
9
+ | `api/` | API design and implementation patterns |
10
+ | `data/` | Data handling, validation, transformation |
11
+ | `ui/` | User interface components and interactions |
12
+ | `testing/` | Testing strategies and patterns |
13
+ | `security/` | Security implementation patterns |
14
+ | `performance/` | Performance optimization patterns |
15
+
16
+ ## Pattern Template
17
+
18
+ Each pattern document should include:
19
+
20
+ ```markdown
21
+ # Pattern Name
22
+
23
+ ## Problem
24
+ What problem does this pattern solve?
25
+
26
+ ## Context
27
+ When should this pattern be applied?
28
+
29
+ ## Solution
30
+ How does the pattern work?
31
+
32
+ ## Code Example
33
+ Concrete implementation example.
34
+
35
+ ## Consequences
36
+ Trade-offs and considerations.
37
+
38
+ ## Related Patterns
39
+ Links to related patterns.
40
+ ```
41
+
42
+ ## Adding a Pattern
43
+
44
+ 1. Identify a recurring problem with a proven solution
45
+ 2. Create document in appropriate category
46
+ 3. Follow the template structure
47
+ 4. Include working code examples
48
+ 5. Reference actual codebase usage
49
+
50
+ ## Using Patterns
51
+
52
+ 1. Identify the problem you're solving
53
+ 2. Check relevant category for existing patterns
54
+ 3. Adapt the pattern to your specific context
55
+ 4. Reference the pattern in your implementation
56
+
57
+ ## Pattern Quality Criteria
58
+
59
+ - **Proven**: Used successfully in production
60
+ - **Documented**: Clear explanation and examples
61
+ - **Maintained**: Updated when implementation changes
62
+ - **Reviewed**: Approved by team lead or senior developer
@@ -1,120 +1,120 @@
1
- # Pattern: [Pattern Name]
2
-
3
- ## Metadata
4
-
5
- | Field | Value |
6
- |-------|-------|
7
- | **Category** | api / data / ui / testing / security / performance |
8
- | **Created** | YYYY-MM-DD |
9
- | **Updated** | YYYY-MM-DD |
10
- | **Author** | {{AUTHOR_NAME}} |
11
- | **Status** | draft / approved / deprecated |
12
-
13
- ## Problem
14
-
15
- Describe the problem this pattern solves.
16
-
17
- - What symptoms indicate this problem?
18
- - What are the consequences of not addressing it?
19
-
20
- ## Context
21
-
22
- When should this pattern be applied?
23
-
24
- ### Use When
25
-
26
- - Condition 1
27
- - Condition 2
28
- - Condition 3
29
-
30
- ### Don't Use When
31
-
32
- - Condition 1
33
- - Condition 2
34
-
35
- ## Solution
36
-
37
- ### Overview
38
-
39
- Brief description of how the pattern works.
40
-
41
- ### Structure
42
-
43
- ```
44
- [Diagram or structure description]
45
- ```
46
-
47
- ### Implementation Steps
48
-
49
- 1. Step 1
50
- 2. Step 2
51
- 3. Step 3
52
-
53
- ## Code Example
54
-
55
- ### Basic Usage
56
-
57
- ```{{LANGUAGE}}
58
- // Example code demonstrating the pattern
59
- ```
60
-
61
- ### Advanced Usage
62
-
63
- ```{{LANGUAGE}}
64
- // More complex example with edge cases
65
- ```
66
-
67
- ### Anti-Pattern (What NOT to Do)
68
-
69
- ```{{LANGUAGE}}
70
- // Example of incorrect implementation
71
- // Explain why this is wrong
72
- ```
73
-
74
- ## Codebase References
75
-
76
- Where this pattern is used in our codebase:
77
-
78
- | Location | Description |
79
- |----------|-------------|
80
- | `path/to/file.ext:123` | Brief description |
81
- | `path/to/other.ext:456` | Brief description |
82
-
83
- ## Consequences
84
-
85
- ### Benefits
86
-
87
- - Benefit 1
88
- - Benefit 2
89
- - Benefit 3
90
-
91
- ### Trade-offs
92
-
93
- - Trade-off 1
94
- - Trade-off 2
95
-
96
- ### Risks
97
-
98
- - Risk 1 and mitigation
99
- - Risk 2 and mitigation
100
-
101
- ## Related Patterns
102
-
103
- | Pattern | Relationship |
104
- |---------|--------------|
105
- | [Pattern Name](./path.md) | How they relate |
106
- | [Pattern Name](./path.md) | How they relate |
107
-
108
- ## References
109
-
110
- - [External resource]()
111
- - [Documentation]()
112
- - [Original source]()
113
-
114
- ---
115
-
116
- ## Revision History
117
-
118
- | Date | Author | Changes |
119
- |------|--------|---------|
120
- | YYYY-MM-DD | Name | Initial version |
1
+ # Pattern: [Pattern Name]
2
+
3
+ ## Metadata
4
+
5
+ | Field | Value |
6
+ |-------|-------|
7
+ | **Category** | api / data / ui / testing / security / performance |
8
+ | **Created** | YYYY-MM-DD |
9
+ | **Updated** | YYYY-MM-DD |
10
+ | **Author** | {{AUTHOR_NAME}} |
11
+ | **Status** | draft / approved / deprecated |
12
+
13
+ ## Problem
14
+
15
+ Describe the problem this pattern solves.
16
+
17
+ - What symptoms indicate this problem?
18
+ - What are the consequences of not addressing it?
19
+
20
+ ## Context
21
+
22
+ When should this pattern be applied?
23
+
24
+ ### Use When
25
+
26
+ - Condition 1
27
+ - Condition 2
28
+ - Condition 3
29
+
30
+ ### Don't Use When
31
+
32
+ - Condition 1
33
+ - Condition 2
34
+
35
+ ## Solution
36
+
37
+ ### Overview
38
+
39
+ Brief description of how the pattern works.
40
+
41
+ ### Structure
42
+
43
+ ```
44
+ [Diagram or structure description]
45
+ ```
46
+
47
+ ### Implementation Steps
48
+
49
+ 1. Step 1
50
+ 2. Step 2
51
+ 3. Step 3
52
+
53
+ ## Code Example
54
+
55
+ ### Basic Usage
56
+
57
+ ```{{LANGUAGE}}
58
+ // Example code demonstrating the pattern
59
+ ```
60
+
61
+ ### Advanced Usage
62
+
63
+ ```{{LANGUAGE}}
64
+ // More complex example with edge cases
65
+ ```
66
+
67
+ ### Anti-Pattern (What NOT to Do)
68
+
69
+ ```{{LANGUAGE}}
70
+ // Example of incorrect implementation
71
+ // Explain why this is wrong
72
+ ```
73
+
74
+ ## Codebase References
75
+
76
+ Where this pattern is used in our codebase:
77
+
78
+ | Location | Description |
79
+ |----------|-------------|
80
+ | `path/to/file.ext:123` | Brief description |
81
+ | `path/to/other.ext:456` | Brief description |
82
+
83
+ ## Consequences
84
+
85
+ ### Benefits
86
+
87
+ - Benefit 1
88
+ - Benefit 2
89
+ - Benefit 3
90
+
91
+ ### Trade-offs
92
+
93
+ - Trade-off 1
94
+ - Trade-off 2
95
+
96
+ ### Risks
97
+
98
+ - Risk 1 and mitigation
99
+ - Risk 2 and mitigation
100
+
101
+ ## Related Patterns
102
+
103
+ | Pattern | Relationship |
104
+ |---------|--------------|
105
+ | [Pattern Name](./path.md) | How they relate |
106
+ | [Pattern Name](./path.md) | How they relate |
107
+
108
+ ## References
109
+
110
+ - [External resource]()
111
+ - [Documentation]()
112
+ - [Original source]()
113
+
114
+ ---
115
+
116
+ ## Revision History
117
+
118
+ | Date | Author | Changes |
119
+ |------|--------|---------|
120
+ | YYYY-MM-DD | Name | Initial version |