feat: Add guidelines for using Codebase Context Specification with AI assistants

Author: killerapp

CODING-ASSISTANT-PROMPT.md

@@ -0,0 +1,51 @@
+## Support the Codebase Context Specification
+
+You are tasked with reading and understanding the Codebase Context Specification files in a project to get explicit context information from the codebase itself.
+
+Follow these guidelines:
+
+1. Look for the following files in the project root and subdirectories:
+   - .context.md (primary)
+   - .context.yaml or .context.yml
+   - .context.json
+   - .contextdocs.md
+   - .contextignore
+
+2. Prioritize reading .context.md files, as they are the primary source of context information.
+
+3. When analyzing .context.md files:
+   - Pay attention to the YAML front matter for structured data.
+   - Carefully read the free-form Markdown content for additional context.
+
+4. For .context.yaml, .context.yml, or .context.json files:
+   - Parse the structured data and understand the relationships between different fields.
+   - Look for key sections such as project-name, version, description, main-technologies, conventions, and ai-prompts.
+
+5. When encountering a .contextdocs.md file:
+   - Understand that it specifies external documentation sources.
+   - Note the types of documentation sources (local, URL, or package) and their relevance to the project.
+
+6. If a .contextignore file is present:
+   - Recognize that it specifies files or directories to be excluded from context consideration.
+   - Apply these exclusions when analyzing the project structure.
+
+7. As you traverse deeper into the directory structure:
+   - Understand that context accumulates and becomes more specific.
+   - More specific contexts in subdirectories provide additional detail to broader contexts.
+
+8. Pay special attention to role-specific sections in the context files, such as:
+   - architecture
+   - development
+   - business-requirements
+   - quality-assurance
+   - deployment
+
+9. Use the information gathered from these files to:
+   - Understand the project's overall structure and purpose.
+   - Identify key technologies, conventions, and best practices.
+   - Recognize project-specific terminology and concepts.
+   - Tailor your responses and code generation to align with the project's guidelines and requirements.
+
+10. Be prepared to provide insights, answer questions, or generate code based on the context provided in these files.
+
+Remember, the Codebase Context Specification is designed to enhance AI-assisted development. Your goal is to leverage this contextual information to provide more accurate, relevant, and project-specific assistance.

README.md

@@ -37,6 +37,20 @@ The Codebase Context Specification is currently in a preview state. We're active
 
 For the full specification, please refer to [CODEBASE-CONTEXT.md](CODEBASE-CONTEXT.md).
 
+## Using with AI Assistants
+
+The [CODING-ASSISTANT-PROMPT.md](CODING-ASSISTANT-PROMPT.md) file provides guidelines for AI assistants to understand and use the Codebase Context Specification. This allows for immediate adoption of the specification without requiring specific tooling integration.
+
+To use the Codebase Context Specification with an AI assistant:
+
+1. Include the content of CODING-ASSISTANT-PROMPT.md in your prompt to the AI assistant.
+2. Ask the AI to analyze your project's context files based on these guidelines.
+3. The AI will be able to provide more accurate and context-aware responses by following the instructions in the prompt.
+
+[A UI element graphic would be inserted here, demonstrating how the Codebase Context Specification could be integrated into development environments]
+
+Note that while this approach allows for immediate use of the specification, some features like .contextignore should eventually be applied by tooling for more robust implementation.
+
 ## Tooling Recommendations
 
 Developers are encouraged to create:
@@ -77,3 +91,4 @@ All contributions will be reviewed and discussed openly. Significant changes may
 
 - [Full Specification (CODEBASE-CONTEXT.md)](CODEBASE-CONTEXT.md)
 - [Context File Example (.context.md)](.context.md)
+- [AI Assistant Prompt (CODING-ASSISTANT-PROMPT.md)](CODING-ASSISTANT-PROMPT.md)

linters/typescript/README.md

@@ -59,6 +59,20 @@ Replace `<directory_to_lint>` with the path to the directory containing your Cod
 - 🚫 Validates ignore patterns in `.contextignore` files
 - 💬 Provides detailed error messages and warnings
 
+## 🤖 Using with AI Assistants
+
+While this linter provides automated validation of CCS files, you can also use the Codebase Context Specification with AI assistants without any specific tooling. The [CODING-ASSISTANT-PROMPT.md](https://github.com/Agentic-Insights/codebase-context-spec/blob/main/CODING-ASSISTANT-PROMPT.md) file in the root directory provides guidelines for AI assistants to understand and use the Codebase Context Specification.
+
+To use the Codebase Context Specification with an AI assistant:
+
+1. Include the content of CODING-ASSISTANT-PROMPT.md in your prompt to the AI assistant.
+2. Ask the AI to analyze your project's context files based on these guidelines.
+3. The AI will be able to provide more accurate and context-aware responses by following the instructions in the prompt.
+
+[A UI element graphic would be inserted here, demonstrating how the Codebase Context Specification could be integrated into development environments]
+
+Note that while this approach allows for immediate use of the specification, some features like .contextignore should eventually be applied by tooling (such as this linter) for more robust implementation.
+
 ## 🛠️ Development
 
 To contribute to this project: