create-claude-context 1.0.0 → 1.2.0
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/LICENSE +21 -21
- package/README.md +146 -146
- package/bin/create-claude-context.js +61 -61
- package/lib/detector.js +373 -373
- package/lib/index.js +170 -170
- package/lib/installer.js +371 -362
- package/lib/placeholder.js +208 -208
- package/lib/prompts.js +287 -287
- package/lib/spinner.js +60 -60
- package/lib/validate.js +147 -147
- package/package.json +59 -59
- package/templates/CLAUDE.md.template +235 -235
- package/templates/base/README.md +257 -257
- package/templates/base/RPI_WORKFLOW_PLAN.md +320 -320
- package/templates/base/agents/api-developer.md +76 -76
- package/templates/base/agents/context-engineer.md +525 -525
- package/templates/base/agents/core-architect.md +76 -76
- package/templates/base/agents/database-ops.md +76 -76
- package/templates/base/agents/deployment-ops.md +76 -76
- package/templates/base/agents/integration-hub.md +76 -76
- package/templates/base/analytics/README.md +114 -114
- package/templates/base/automation/config.json +58 -0
- package/templates/base/automation/generators/code-mapper.js +308 -0
- package/templates/base/automation/generators/index-builder.js +321 -0
- package/templates/base/automation/hooks/post-commit.sh +83 -0
- package/templates/base/automation/hooks/pre-commit.sh +103 -0
- package/templates/base/ci-templates/README.md +108 -108
- package/templates/base/ci-templates/github-actions/context-check.yml +144 -144
- package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -105
- package/templates/base/commands/analytics.md +238 -238
- package/templates/base/commands/auto-sync.md +172 -0
- package/templates/base/commands/collab.md +194 -194
- package/templates/base/commands/help.md +450 -450
- package/templates/base/commands/rpi-implement.md +115 -115
- package/templates/base/commands/rpi-plan.md +93 -93
- package/templates/base/commands/rpi-research.md +88 -88
- package/templates/base/commands/session-resume.md +144 -0
- package/templates/base/commands/session-save.md +112 -0
- package/templates/base/commands/validate-all.md +77 -77
- package/templates/base/commands/verify-docs-current.md +86 -86
- package/templates/base/config/base.json +57 -57
- package/templates/base/config/environments/development.json +13 -13
- package/templates/base/config/environments/production.json +17 -17
- package/templates/base/config/environments/staging.json +13 -13
- package/templates/base/config/local.json.example +21 -21
- package/templates/base/context/.meta/generated-at.json +18 -0
- package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -156
- package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -94
- package/templates/base/context/FILE_OWNERSHIP.md +57 -0
- package/templates/base/context/INTEGRATION_POINTS.md +92 -0
- package/templates/base/context/KNOWN_GOTCHAS.md +195 -195
- package/templates/base/context/TESTING_MAP.md +95 -0
- package/templates/base/context/WORKFLOW_INDEX.md +129 -129
- package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -294
- package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -255
- package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -44
- package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -38
- package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -39
- package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -39
- package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -38
- package/templates/base/knowledge/README.md +98 -98
- package/templates/base/knowledge/sessions/README.md +88 -88
- package/templates/base/knowledge/sessions/TEMPLATE.md +150 -150
- package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -144
- package/templates/base/knowledge/shared/decisions/README.md +49 -49
- package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -123
- package/templates/base/knowledge/shared/patterns/README.md +62 -62
- package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -120
- package/templates/base/plans/PLAN_TEMPLATE.md +250 -250
- package/templates/base/research/RESEARCH_TEMPLATE.md +153 -153
- package/templates/base/schemas/agent.schema.json +141 -141
- package/templates/base/schemas/anchors.schema.json +54 -0
- package/templates/base/schemas/automation.schema.json +93 -0
- package/templates/base/schemas/command.schema.json +134 -134
- package/templates/base/schemas/hashes.schema.json +40 -0
- package/templates/base/schemas/manifest.schema.json +117 -117
- package/templates/base/schemas/plan.schema.json +136 -136
- package/templates/base/schemas/research.schema.json +115 -115
- package/templates/base/schemas/roles.schema.json +34 -0
- package/templates/base/schemas/session.schema.json +77 -0
- package/templates/base/schemas/settings.schema.json +244 -244
- package/templates/base/schemas/staleness.schema.json +53 -0
- package/templates/base/schemas/team-config.schema.json +42 -0
- package/templates/base/schemas/workflow.schema.json +126 -126
- package/templates/base/session/checkpoints/.gitkeep +2 -0
- package/templates/base/session/current/state.json +20 -0
- package/templates/base/session/history/.gitkeep +2 -0
- package/templates/base/settings.json +79 -57
- package/templates/base/standards/COMPATIBILITY.md +219 -219
- package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -280
- package/templates/base/standards/QUALITY_CHECKLIST.md +211 -211
- package/templates/base/standards/README.md +66 -66
- package/templates/base/sync/anchors.json +6 -0
- package/templates/base/sync/hashes.json +6 -0
- package/templates/base/sync/staleness.json +10 -0
- package/templates/base/team/README.md +168 -168
- package/templates/base/team/config.json +79 -79
- package/templates/base/team/roles.json +145 -145
- package/templates/base/tools/bin/claude-context.js +151 -151
- package/templates/base/tools/lib/anchor-resolver.js +276 -0
- package/templates/base/tools/lib/config-loader.js +363 -363
- package/templates/base/tools/lib/detector.js +350 -350
- package/templates/base/tools/lib/diagnose.js +206 -206
- package/templates/base/tools/lib/drift-detector.js +373 -0
- package/templates/base/tools/lib/errors.js +199 -199
- package/templates/base/tools/lib/index.js +36 -24
- package/templates/base/tools/lib/init.js +192 -192
- package/templates/base/tools/lib/logger.js +230 -230
- package/templates/base/tools/lib/placeholder.js +201 -201
- package/templates/base/tools/lib/session-manager.js +354 -0
- package/templates/base/tools/lib/validate.js +521 -521
- package/templates/base/tools/package.json +49 -49
|
@@ -1,211 +1,211 @@
|
|
|
1
|
-
# Quality Checklist
|
|
2
|
-
|
|
3
|
-
Use this checklist to ensure your Claude Context Engineering implementation meets quality standards.
|
|
4
|
-
|
|
5
|
-
## For Projects Using the Template
|
|
6
|
-
|
|
7
|
-
### Initial Setup
|
|
8
|
-
|
|
9
|
-
- [ ] All `{{PLACEHOLDER}}` values replaced with project-specific content
|
|
10
|
-
- [ ] CLAUDE.md customized for your codebase
|
|
11
|
-
- [ ] Tech stack correctly identified
|
|
12
|
-
- [ ] File paths in documentation are accurate
|
|
13
|
-
- [ ] Line numbers in code references are current
|
|
14
|
-
|
|
15
|
-
### Documentation Quality
|
|
16
|
-
|
|
17
|
-
- [ ] INDEX files reflect actual directory structure
|
|
18
|
-
- [ ] Workflow documents describe real system behavior
|
|
19
|
-
- [ ] Architecture snapshot matches current architecture
|
|
20
|
-
- [ ] Known gotchas are documented and current
|
|
21
|
-
- [ ] Code-to-workflow map is accurate
|
|
22
|
-
|
|
23
|
-
### Context Budget
|
|
24
|
-
|
|
25
|
-
- [ ] Total documentation under 40% of context budget (~80K tokens)
|
|
26
|
-
- [ ] No single file exceeds 10K tokens
|
|
27
|
-
- [ ] Indexes are concise pointers, not content dumps
|
|
28
|
-
- [ ] Rarely-used content in separate files
|
|
29
|
-
|
|
30
|
-
### Validation
|
|
31
|
-
|
|
32
|
-
- [ ] `npx claude-context validate --all` passes
|
|
33
|
-
- [ ] All internal links resolve
|
|
34
|
-
- [ ] JSON files pass schema validation
|
|
35
|
-
- [ ] No broken file references
|
|
36
|
-
|
|
37
|
-
---
|
|
38
|
-
|
|
39
|
-
## For Extension Authors
|
|
40
|
-
|
|
41
|
-
### Structure
|
|
42
|
-
|
|
43
|
-
- [ ] `manifest.json` present and valid
|
|
44
|
-
- [ ] `README.md` complete with all sections
|
|
45
|
-
- [ ] `LICENSE` file included
|
|
46
|
-
- [ ] `CHANGELOG.md` documents version history
|
|
47
|
-
- [ ] Directory structure follows convention
|
|
48
|
-
|
|
49
|
-
### Manifest
|
|
50
|
-
|
|
51
|
-
- [ ] `name` is lowercase with hyphens only
|
|
52
|
-
- [ ] `version` follows semver (MAJOR.MINOR.PATCH)
|
|
53
|
-
- [ ] `description` is under 200 characters
|
|
54
|
-
- [ ] `author` information complete
|
|
55
|
-
- [ ] `license` is valid SPDX identifier
|
|
56
|
-
- [ ] `claude_context_version` specifies compatibility
|
|
57
|
-
- [ ] `contents` lists all provided components
|
|
58
|
-
|
|
59
|
-
### Documentation
|
|
60
|
-
|
|
61
|
-
- [ ] Installation instructions clear and tested
|
|
62
|
-
- [ ] All components documented with examples
|
|
63
|
-
- [ ] Configuration requirements specified
|
|
64
|
-
- [ ] Troubleshooting section included
|
|
65
|
-
- [ ] No placeholder text remains
|
|
66
|
-
|
|
67
|
-
### Code Quality
|
|
68
|
-
|
|
69
|
-
- [ ] Agents follow frontmatter schema
|
|
70
|
-
- [ ] Commands follow frontmatter schema
|
|
71
|
-
- [ ] Workflows follow workflow schema
|
|
72
|
-
- [ ] All required metadata present
|
|
73
|
-
- [ ] Context budgets documented
|
|
74
|
-
|
|
75
|
-
### Testing
|
|
76
|
-
|
|
77
|
-
- [ ] Installs without errors
|
|
78
|
-
- [ ] All examples work as documented
|
|
79
|
-
- [ ] No conflicts with base template
|
|
80
|
-
- [ ] Tested with specified template version
|
|
81
|
-
|
|
82
|
-
### Security
|
|
83
|
-
|
|
84
|
-
- [ ] No hardcoded secrets or API keys
|
|
85
|
-
- [ ] No personal data included
|
|
86
|
-
- [ ] External calls documented
|
|
87
|
-
- [ ] File operations are safe
|
|
88
|
-
- [ ] License is compatible
|
|
89
|
-
|
|
90
|
-
---
|
|
91
|
-
|
|
92
|
-
## For Template Contributors
|
|
93
|
-
|
|
94
|
-
### Code Changes
|
|
95
|
-
|
|
96
|
-
- [ ] Follows existing code style
|
|
97
|
-
- [ ] Includes appropriate tests
|
|
98
|
-
- [ ] Documentation updated
|
|
99
|
-
- [ ] CHANGELOG entry added
|
|
100
|
-
- [ ] Breaking changes documented
|
|
101
|
-
|
|
102
|
-
### Schema Changes
|
|
103
|
-
|
|
104
|
-
- [ ] Schema version incremented
|
|
105
|
-
- [ ] Migration path documented
|
|
106
|
-
- [ ] Backward compatibility considered
|
|
107
|
-
- [ ] Examples updated
|
|
108
|
-
|
|
109
|
-
### Documentation Changes
|
|
110
|
-
|
|
111
|
-
- [ ] Links verified
|
|
112
|
-
- [ ] Line numbers updated
|
|
113
|
-
- [ ] Consistent formatting
|
|
114
|
-
- [ ] Grammar and spelling checked
|
|
115
|
-
|
|
116
|
-
### Pull Request
|
|
117
|
-
|
|
118
|
-
- [ ] Clear description of changes
|
|
119
|
-
- [ ] Issue reference (if applicable)
|
|
120
|
-
- [ ] Tests passing
|
|
121
|
-
- [ ] Documentation updated
|
|
122
|
-
- [ ] CHANGELOG updated
|
|
123
|
-
|
|
124
|
-
---
|
|
125
|
-
|
|
126
|
-
## Validation Commands
|
|
127
|
-
|
|
128
|
-
Run these commands to validate your implementation:
|
|
129
|
-
|
|
130
|
-
```bash
|
|
131
|
-
# Full validation suite
|
|
132
|
-
npx claude-context validate --all
|
|
133
|
-
|
|
134
|
-
# Specific validations
|
|
135
|
-
npx claude-context validate --schema # JSON schemas
|
|
136
|
-
npx claude-context validate --links # Internal links
|
|
137
|
-
npx claude-context validate --placeholders # Unreplaced placeholders
|
|
138
|
-
npx claude-context validate --structure # Directory structure
|
|
139
|
-
npx claude-context validate --lines # Line number accuracy
|
|
140
|
-
|
|
141
|
-
# Diagnostics
|
|
142
|
-
npx claude-context diagnose # System health check
|
|
143
|
-
npx claude-context diagnose --fix # Auto-fix issues
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
## Quality Levels
|
|
147
|
-
|
|
148
|
-
### Level 1: Minimal (Required)
|
|
149
|
-
|
|
150
|
-
- All placeholders replaced
|
|
151
|
-
- Basic documentation present
|
|
152
|
-
- Validation passes
|
|
153
|
-
- No broken links
|
|
154
|
-
|
|
155
|
-
### Level 2: Standard (Recommended)
|
|
156
|
-
|
|
157
|
-
- Complete documentation
|
|
158
|
-
- Accurate line numbers (>60%)
|
|
159
|
-
- Context budget under 40%
|
|
160
|
-
- Regular validation in CI
|
|
161
|
-
|
|
162
|
-
### Level 3: Exemplary (Best Practice)
|
|
163
|
-
|
|
164
|
-
- Comprehensive documentation
|
|
165
|
-
- Line accuracy >80%
|
|
166
|
-
- Context budget under 30%
|
|
167
|
-
- Automated documentation updates
|
|
168
|
-
- Full CI/CD integration
|
|
169
|
-
|
|
170
|
-
## Common Issues
|
|
171
|
-
|
|
172
|
-
### Placeholder Not Replaced
|
|
173
|
-
|
|
174
|
-
**Symptom:** `{{PLACEHOLDER}}` appears in output
|
|
175
|
-
|
|
176
|
-
**Fix:** Search for all `{{` patterns and replace:
|
|
177
|
-
```bash
|
|
178
|
-
grep -r "{{" .claude/
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
### Broken Internal Link
|
|
182
|
-
|
|
183
|
-
**Symptom:** Link validation fails
|
|
184
|
-
|
|
185
|
-
**Fix:** Update link path or create missing file:
|
|
186
|
-
```bash
|
|
187
|
-
npx claude-context validate --links --verbose
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
### Context Budget Exceeded
|
|
191
|
-
|
|
192
|
-
**Symptom:** Documentation >40% of budget
|
|
193
|
-
|
|
194
|
-
**Fix:**
|
|
195
|
-
1. Split large files
|
|
196
|
-
2. Move details to separate files
|
|
197
|
-
3. Compact verbose sections
|
|
198
|
-
|
|
199
|
-
### Line Number Drift
|
|
200
|
-
|
|
201
|
-
**Symptom:** Code references point to wrong lines
|
|
202
|
-
|
|
203
|
-
**Fix:**
|
|
204
|
-
```bash
|
|
205
|
-
npx claude-context diagnose --fix
|
|
206
|
-
```
|
|
207
|
-
|
|
208
|
-
## Related
|
|
209
|
-
|
|
210
|
-
- [Extension Guidelines](./EXTENSION_GUIDELINES.md)
|
|
211
|
-
- [Compatibility Guide](./COMPATIBILITY.md)
|
|
1
|
+
# Quality Checklist
|
|
2
|
+
|
|
3
|
+
Use this checklist to ensure your Claude Context Engineering implementation meets quality standards.
|
|
4
|
+
|
|
5
|
+
## For Projects Using the Template
|
|
6
|
+
|
|
7
|
+
### Initial Setup
|
|
8
|
+
|
|
9
|
+
- [ ] All `{{PLACEHOLDER}}` values replaced with project-specific content
|
|
10
|
+
- [ ] CLAUDE.md customized for your codebase
|
|
11
|
+
- [ ] Tech stack correctly identified
|
|
12
|
+
- [ ] File paths in documentation are accurate
|
|
13
|
+
- [ ] Line numbers in code references are current
|
|
14
|
+
|
|
15
|
+
### Documentation Quality
|
|
16
|
+
|
|
17
|
+
- [ ] INDEX files reflect actual directory structure
|
|
18
|
+
- [ ] Workflow documents describe real system behavior
|
|
19
|
+
- [ ] Architecture snapshot matches current architecture
|
|
20
|
+
- [ ] Known gotchas are documented and current
|
|
21
|
+
- [ ] Code-to-workflow map is accurate
|
|
22
|
+
|
|
23
|
+
### Context Budget
|
|
24
|
+
|
|
25
|
+
- [ ] Total documentation under 40% of context budget (~80K tokens)
|
|
26
|
+
- [ ] No single file exceeds 10K tokens
|
|
27
|
+
- [ ] Indexes are concise pointers, not content dumps
|
|
28
|
+
- [ ] Rarely-used content in separate files
|
|
29
|
+
|
|
30
|
+
### Validation
|
|
31
|
+
|
|
32
|
+
- [ ] `npx claude-context validate --all` passes
|
|
33
|
+
- [ ] All internal links resolve
|
|
34
|
+
- [ ] JSON files pass schema validation
|
|
35
|
+
- [ ] No broken file references
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## For Extension Authors
|
|
40
|
+
|
|
41
|
+
### Structure
|
|
42
|
+
|
|
43
|
+
- [ ] `manifest.json` present and valid
|
|
44
|
+
- [ ] `README.md` complete with all sections
|
|
45
|
+
- [ ] `LICENSE` file included
|
|
46
|
+
- [ ] `CHANGELOG.md` documents version history
|
|
47
|
+
- [ ] Directory structure follows convention
|
|
48
|
+
|
|
49
|
+
### Manifest
|
|
50
|
+
|
|
51
|
+
- [ ] `name` is lowercase with hyphens only
|
|
52
|
+
- [ ] `version` follows semver (MAJOR.MINOR.PATCH)
|
|
53
|
+
- [ ] `description` is under 200 characters
|
|
54
|
+
- [ ] `author` information complete
|
|
55
|
+
- [ ] `license` is valid SPDX identifier
|
|
56
|
+
- [ ] `claude_context_version` specifies compatibility
|
|
57
|
+
- [ ] `contents` lists all provided components
|
|
58
|
+
|
|
59
|
+
### Documentation
|
|
60
|
+
|
|
61
|
+
- [ ] Installation instructions clear and tested
|
|
62
|
+
- [ ] All components documented with examples
|
|
63
|
+
- [ ] Configuration requirements specified
|
|
64
|
+
- [ ] Troubleshooting section included
|
|
65
|
+
- [ ] No placeholder text remains
|
|
66
|
+
|
|
67
|
+
### Code Quality
|
|
68
|
+
|
|
69
|
+
- [ ] Agents follow frontmatter schema
|
|
70
|
+
- [ ] Commands follow frontmatter schema
|
|
71
|
+
- [ ] Workflows follow workflow schema
|
|
72
|
+
- [ ] All required metadata present
|
|
73
|
+
- [ ] Context budgets documented
|
|
74
|
+
|
|
75
|
+
### Testing
|
|
76
|
+
|
|
77
|
+
- [ ] Installs without errors
|
|
78
|
+
- [ ] All examples work as documented
|
|
79
|
+
- [ ] No conflicts with base template
|
|
80
|
+
- [ ] Tested with specified template version
|
|
81
|
+
|
|
82
|
+
### Security
|
|
83
|
+
|
|
84
|
+
- [ ] No hardcoded secrets or API keys
|
|
85
|
+
- [ ] No personal data included
|
|
86
|
+
- [ ] External calls documented
|
|
87
|
+
- [ ] File operations are safe
|
|
88
|
+
- [ ] License is compatible
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## For Template Contributors
|
|
93
|
+
|
|
94
|
+
### Code Changes
|
|
95
|
+
|
|
96
|
+
- [ ] Follows existing code style
|
|
97
|
+
- [ ] Includes appropriate tests
|
|
98
|
+
- [ ] Documentation updated
|
|
99
|
+
- [ ] CHANGELOG entry added
|
|
100
|
+
- [ ] Breaking changes documented
|
|
101
|
+
|
|
102
|
+
### Schema Changes
|
|
103
|
+
|
|
104
|
+
- [ ] Schema version incremented
|
|
105
|
+
- [ ] Migration path documented
|
|
106
|
+
- [ ] Backward compatibility considered
|
|
107
|
+
- [ ] Examples updated
|
|
108
|
+
|
|
109
|
+
### Documentation Changes
|
|
110
|
+
|
|
111
|
+
- [ ] Links verified
|
|
112
|
+
- [ ] Line numbers updated
|
|
113
|
+
- [ ] Consistent formatting
|
|
114
|
+
- [ ] Grammar and spelling checked
|
|
115
|
+
|
|
116
|
+
### Pull Request
|
|
117
|
+
|
|
118
|
+
- [ ] Clear description of changes
|
|
119
|
+
- [ ] Issue reference (if applicable)
|
|
120
|
+
- [ ] Tests passing
|
|
121
|
+
- [ ] Documentation updated
|
|
122
|
+
- [ ] CHANGELOG updated
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
## Validation Commands
|
|
127
|
+
|
|
128
|
+
Run these commands to validate your implementation:
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
# Full validation suite
|
|
132
|
+
npx claude-context validate --all
|
|
133
|
+
|
|
134
|
+
# Specific validations
|
|
135
|
+
npx claude-context validate --schema # JSON schemas
|
|
136
|
+
npx claude-context validate --links # Internal links
|
|
137
|
+
npx claude-context validate --placeholders # Unreplaced placeholders
|
|
138
|
+
npx claude-context validate --structure # Directory structure
|
|
139
|
+
npx claude-context validate --lines # Line number accuracy
|
|
140
|
+
|
|
141
|
+
# Diagnostics
|
|
142
|
+
npx claude-context diagnose # System health check
|
|
143
|
+
npx claude-context diagnose --fix # Auto-fix issues
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## Quality Levels
|
|
147
|
+
|
|
148
|
+
### Level 1: Minimal (Required)
|
|
149
|
+
|
|
150
|
+
- All placeholders replaced
|
|
151
|
+
- Basic documentation present
|
|
152
|
+
- Validation passes
|
|
153
|
+
- No broken links
|
|
154
|
+
|
|
155
|
+
### Level 2: Standard (Recommended)
|
|
156
|
+
|
|
157
|
+
- Complete documentation
|
|
158
|
+
- Accurate line numbers (>60%)
|
|
159
|
+
- Context budget under 40%
|
|
160
|
+
- Regular validation in CI
|
|
161
|
+
|
|
162
|
+
### Level 3: Exemplary (Best Practice)
|
|
163
|
+
|
|
164
|
+
- Comprehensive documentation
|
|
165
|
+
- Line accuracy >80%
|
|
166
|
+
- Context budget under 30%
|
|
167
|
+
- Automated documentation updates
|
|
168
|
+
- Full CI/CD integration
|
|
169
|
+
|
|
170
|
+
## Common Issues
|
|
171
|
+
|
|
172
|
+
### Placeholder Not Replaced
|
|
173
|
+
|
|
174
|
+
**Symptom:** `{{PLACEHOLDER}}` appears in output
|
|
175
|
+
|
|
176
|
+
**Fix:** Search for all `{{` patterns and replace:
|
|
177
|
+
```bash
|
|
178
|
+
grep -r "{{" .claude/
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Broken Internal Link
|
|
182
|
+
|
|
183
|
+
**Symptom:** Link validation fails
|
|
184
|
+
|
|
185
|
+
**Fix:** Update link path or create missing file:
|
|
186
|
+
```bash
|
|
187
|
+
npx claude-context validate --links --verbose
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Context Budget Exceeded
|
|
191
|
+
|
|
192
|
+
**Symptom:** Documentation >40% of budget
|
|
193
|
+
|
|
194
|
+
**Fix:**
|
|
195
|
+
1. Split large files
|
|
196
|
+
2. Move details to separate files
|
|
197
|
+
3. Compact verbose sections
|
|
198
|
+
|
|
199
|
+
### Line Number Drift
|
|
200
|
+
|
|
201
|
+
**Symptom:** Code references point to wrong lines
|
|
202
|
+
|
|
203
|
+
**Fix:**
|
|
204
|
+
```bash
|
|
205
|
+
npx claude-context diagnose --fix
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
## Related
|
|
209
|
+
|
|
210
|
+
- [Extension Guidelines](./EXTENSION_GUIDELINES.md)
|
|
211
|
+
- [Compatibility Guide](./COMPATIBILITY.md)
|
|
@@ -1,66 +1,66 @@
|
|
|
1
|
-
# Standards
|
|
2
|
-
|
|
3
|
-
Quality standards, guidelines, and compatibility information for Claude Context Engineering.
|
|
4
|
-
|
|
5
|
-
## Contents
|
|
6
|
-
|
|
7
|
-
| Document | Description |
|
|
8
|
-
|----------|-------------|
|
|
9
|
-
| [EXTENSION_GUIDELINES.md](./EXTENSION_GUIDELINES.md) | How to create and publish extensions |
|
|
10
|
-
| [QUALITY_CHECKLIST.md](./QUALITY_CHECKLIST.md) | Quality requirements and validation checklist |
|
|
11
|
-
| [COMPATIBILITY.md](./COMPATIBILITY.md) | Version compatibility and migration information |
|
|
12
|
-
|
|
13
|
-
## Quick Reference
|
|
14
|
-
|
|
15
|
-
### For Users
|
|
16
|
-
|
|
17
|
-
Use the [Quality Checklist](./QUALITY_CHECKLIST.md) to ensure your implementation meets standards:
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
# Run full validation
|
|
21
|
-
npx claude-context validate --all
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
### For Extension Authors
|
|
25
|
-
|
|
26
|
-
Follow the [Extension Guidelines](./EXTENSION_GUIDELINES.md) to create publishable extensions:
|
|
27
|
-
|
|
28
|
-
1. Structure your extension correctly
|
|
29
|
-
2. Include required manifest and documentation
|
|
30
|
-
3. Meet quality requirements
|
|
31
|
-
4. Submit for review
|
|
32
|
-
|
|
33
|
-
### For Contributors
|
|
34
|
-
|
|
35
|
-
Check [Compatibility](./COMPATIBILITY.md) when making changes:
|
|
36
|
-
|
|
37
|
-
- Follow semantic versioning
|
|
38
|
-
- Document breaking changes
|
|
39
|
-
- Provide migration paths
|
|
40
|
-
|
|
41
|
-
## Standards Summary
|
|
42
|
-
|
|
43
|
-
### Quality Levels
|
|
44
|
-
|
|
45
|
-
| Level | Requirements |
|
|
46
|
-
|-------|--------------|
|
|
47
|
-
| Minimal | Placeholders replaced, validation passes |
|
|
48
|
-
| Standard | Complete documentation, <40% context budget |
|
|
49
|
-
| Exemplary | >80% accuracy, <30% budget, CI integration |
|
|
50
|
-
|
|
51
|
-
### Extension Requirements
|
|
52
|
-
|
|
53
|
-
| Requirement | Status |
|
|
54
|
-
|-------------|--------|
|
|
55
|
-
| manifest.json | Required |
|
|
56
|
-
| README.md | Required |
|
|
57
|
-
| LICENSE | Required |
|
|
58
|
-
| CHANGELOG.md | Recommended |
|
|
59
|
-
| Tests | Recommended |
|
|
60
|
-
|
|
61
|
-
### Version Compatibility
|
|
62
|
-
|
|
63
|
-
- Use `^1.0.0` for extension compatibility ranges
|
|
64
|
-
- Major version = breaking changes
|
|
65
|
-
- Minor version = new features
|
|
66
|
-
- Patch version = bug fixes
|
|
1
|
+
# Standards
|
|
2
|
+
|
|
3
|
+
Quality standards, guidelines, and compatibility information for Claude Context Engineering.
|
|
4
|
+
|
|
5
|
+
## Contents
|
|
6
|
+
|
|
7
|
+
| Document | Description |
|
|
8
|
+
|----------|-------------|
|
|
9
|
+
| [EXTENSION_GUIDELINES.md](./EXTENSION_GUIDELINES.md) | How to create and publish extensions |
|
|
10
|
+
| [QUALITY_CHECKLIST.md](./QUALITY_CHECKLIST.md) | Quality requirements and validation checklist |
|
|
11
|
+
| [COMPATIBILITY.md](./COMPATIBILITY.md) | Version compatibility and migration information |
|
|
12
|
+
|
|
13
|
+
## Quick Reference
|
|
14
|
+
|
|
15
|
+
### For Users
|
|
16
|
+
|
|
17
|
+
Use the [Quality Checklist](./QUALITY_CHECKLIST.md) to ensure your implementation meets standards:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# Run full validation
|
|
21
|
+
npx claude-context validate --all
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### For Extension Authors
|
|
25
|
+
|
|
26
|
+
Follow the [Extension Guidelines](./EXTENSION_GUIDELINES.md) to create publishable extensions:
|
|
27
|
+
|
|
28
|
+
1. Structure your extension correctly
|
|
29
|
+
2. Include required manifest and documentation
|
|
30
|
+
3. Meet quality requirements
|
|
31
|
+
4. Submit for review
|
|
32
|
+
|
|
33
|
+
### For Contributors
|
|
34
|
+
|
|
35
|
+
Check [Compatibility](./COMPATIBILITY.md) when making changes:
|
|
36
|
+
|
|
37
|
+
- Follow semantic versioning
|
|
38
|
+
- Document breaking changes
|
|
39
|
+
- Provide migration paths
|
|
40
|
+
|
|
41
|
+
## Standards Summary
|
|
42
|
+
|
|
43
|
+
### Quality Levels
|
|
44
|
+
|
|
45
|
+
| Level | Requirements |
|
|
46
|
+
|-------|--------------|
|
|
47
|
+
| Minimal | Placeholders replaced, validation passes |
|
|
48
|
+
| Standard | Complete documentation, <40% context budget |
|
|
49
|
+
| Exemplary | >80% accuracy, <30% budget, CI integration |
|
|
50
|
+
|
|
51
|
+
### Extension Requirements
|
|
52
|
+
|
|
53
|
+
| Requirement | Status |
|
|
54
|
+
|-------------|--------|
|
|
55
|
+
| manifest.json | Required |
|
|
56
|
+
| README.md | Required |
|
|
57
|
+
| LICENSE | Required |
|
|
58
|
+
| CHANGELOG.md | Recommended |
|
|
59
|
+
| Tests | Recommended |
|
|
60
|
+
|
|
61
|
+
### Version Compatibility
|
|
62
|
+
|
|
63
|
+
- Use `^1.0.0` for extension compatibility ranges
|
|
64
|
+
- Major version = breaking changes
|
|
65
|
+
- Minor version = new features
|
|
66
|
+
- Patch version = bug fixes
|