@@ -42,6 +42,7 @@ Create a `innersource-ai/` folder in the repository root containing:
4242#### Core Documentation Files (Required)
4343
4444` PROMPT.md ` : Project-specific instructions for AI tools
45+
4546* Naming conventions (variables, functions, classes, files)
4647* Logging patterns and error handling approaches
4748* Testing strategy and preferred testing frameworks
@@ -50,13 +51,15 @@ Create a `innersource-ai/` folder in the repository root containing:
5051* Preferred libraries and frameworks for specific tasks
5152
5253` ARCHITECTURE.md ` : Lightweight system overview
54+
5355* High-level system architecture and component relationships
5456* Data flow patterns and API design principles
5557* Dependency management guidelines
5658* Module organization and layering principles
5759* Integration patterns with external systems
5860
5961` STYLE_GUIDE.md ` : Comprehensive coding guidelines
62+
6063* Language-specific style rules
6164* Code organization patterns
6265* Documentation standards
@@ -68,6 +71,7 @@ Create a `innersource-ai/` folder in the repository root containing:
6871##### Practical Examples
6972
7073` EXAMPLES/ ` : Sample code files demonstrating best practices
74+
7175* ` good-examples/ ` : Well-written code snippets with explanations
7276* ` bad-examples/ ` : Common mistakes with explanations of why they're problematic
7377* ` refactoring-examples/ ` : Before/after code showing proper improvements
@@ -76,12 +80,14 @@ Create a `innersource-ai/` folder in the repository root containing:
7680##### Configuration and Tooling
7781
7882` CONFIG/ ` : Shared formatter and analysis configurations
83+
7984* ` .prettierrc ` , ` .eslintrc ` , or equivalent formatting configs
8085* ` .editorconfig ` for consistent editor settings
8186* Static analysis tool configurations
8287* Pre-commit hook configurations
8388
8489` INTEGRATION/ ` : AI tool-specific integration guides
90+
8591* GitHub Copilot workspace configuration
8692* Custom GPT instructions and prompts
8793* IDE plugin configurations
@@ -90,6 +96,7 @@ Create a `innersource-ai/` folder in the repository root containing:
9096##### Advanced Features
9197
9298` EMBEDDINGS/ ` (Optional): For advanced LLM integrations
99+
93100* Searchable knowledge base of project patterns
94101* Vector embeddings of code examples
95102* Semantic search capabilities for finding relevant patterns
@@ -101,12 +108,14 @@ Create a `innersource-ai/` folder in the repository root containing:
101108### Usage Patterns
102109
103110#### For Contributors
111+
104112* ** Before Starting** : Review the AI context package to understand project standards
105113* ** During Development** : Reference specific files when prompting AI tools
106114* ** Code Generation** : Include relevant context snippets in AI prompts
107115* ** Validation** : Use provided examples to verify AI-generated code aligns with standards
108116
109117#### For AI Tool Integration
118+
110119* ** Direct Reference** : Copy relevant sections into AI tool prompts
111120* ** URL Integration** : Reference files via repository URLs in AI tools that support web access
112121* ** IDE Integration** : Configure AI plugins to automatically include context
0 commit comments