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
The Codebase Context Specification provides a flexible, standardized approach to enriching codebases with contextual information for AI models. By adopting this convention and including role-specific information, development teams can enhance AI-assisted workflows, improving code quality and development efficiency across projects of any scale or complexity. The addition of role-specific guidelines and consistent naming conventions ensures that AI models have access to comprehensive, relevant, and well-structured information tailored to different aspects of the software development lifecycle.
534
-
535
-
## 9. TypeScript Linter Implementation
536
-
537
-
For details on the TypeScript implementation of the linter for validating Codebase Context Specification files, please refer to the [TypeScript Linter README](linters/typescript/README.md).
Copy file name to clipboardExpand all lines: GENERATE-CONTEXT-PROMPT.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -190,18 +190,26 @@ When referencing diagrams in the .context.md file:
190
190
191
191
Remember, the goal is to create .context.md and .contextdocs.md files that provide valuable context for both human developers and AI assistants, enabling more effective collaboration and development on the project.
192
192
193
-
## Linting and testing the new .context.md and .contextdocs.md
193
+
## Validating the .context.md and .contextdocs.md Files
194
194
195
-
Use the terminal to run the linting command to review the output.
195
+
Use the terminal to run the validation command to review the output.
196
196
Fix any errors or warnings by reviewing the codebase and filling in the missing pieces.
197
197
198
-
Usage of official linter for .context.md and .contextdocs.md files:
198
+
Usage of the official CLI tool for validating .context.md and .contextdocs.md files:
199
199
200
-
1.Run the linter from the directory the files are in:
201
-
`npx codebase-context-lint .`
202
-
2. Repair and re-run until you have full coverage for both files.
203
-
3. Pay special attention to the format of the resources in .contextdocs.md, ensuring they are objects with single key-value pairs.
200
+
1.Install the CLI tool:
201
+
```bash
202
+
npm install -g @agentic-insights/cc-cli
203
+
```
204
204
205
-
By following these guidelines and instructions, you should be able to create comprehensive and properly formatted .context.md and .contextdocs.md files that will pass the linter checks and provide valuable context for the project.
205
+
2. Run the validation command from the directory containing the files:
206
+
```bash
207
+
cc validate
208
+
```
209
+
210
+
3. Review any validation errors and fix them according to the specification.
211
+
4. Pay special attention to the format of the resources in .contextdocs.md, ensuring they are objects with single key-value pairs.
212
+
213
+
By following these guidelines and instructions, you should be able to create comprehensive and properly formatted .context.md and .contextdocs.md files that will pass validation and provide valuable context for the project.
206
214
207
215
Review the CODEBASE-CONTEXT.md file provided for the full specification.
0 commit comments