@@ -42,6 +42,7 @@ Create a `innersource-ai/` folder in the repository root containing:
42
42
#### Core Documentation Files (Required)
43
43
44
44
` PROMPT.md ` : Project-specific instructions for AI tools
45
+
45
46
* Naming conventions (variables, functions, classes, files)
46
47
* Logging patterns and error handling approaches
47
48
* Testing strategy and preferred testing frameworks
@@ -50,13 +51,15 @@ Create a `innersource-ai/` folder in the repository root containing:
50
51
* Preferred libraries and frameworks for specific tasks
51
52
52
53
` ARCHITECTURE.md ` : Lightweight system overview
54
+
53
55
* High-level system architecture and component relationships
54
56
* Data flow patterns and API design principles
55
57
* Dependency management guidelines
56
58
* Module organization and layering principles
57
59
* Integration patterns with external systems
58
60
59
61
` STYLE_GUIDE.md ` : Comprehensive coding guidelines
62
+
60
63
* Language-specific style rules
61
64
* Code organization patterns
62
65
* Documentation standards
@@ -68,6 +71,7 @@ Create a `innersource-ai/` folder in the repository root containing:
68
71
##### Practical Examples
69
72
70
73
` EXAMPLES/ ` : Sample code files demonstrating best practices
74
+
71
75
* ` good-examples/ ` : Well-written code snippets with explanations
72
76
* ` bad-examples/ ` : Common mistakes with explanations of why they're problematic
73
77
* ` refactoring-examples/ ` : Before/after code showing proper improvements
@@ -76,12 +80,14 @@ Create a `innersource-ai/` folder in the repository root containing:
76
80
##### Configuration and Tooling
77
81
78
82
` CONFIG/ ` : Shared formatter and analysis configurations
83
+
79
84
* ` .prettierrc ` , ` .eslintrc ` , or equivalent formatting configs
80
85
* ` .editorconfig ` for consistent editor settings
81
86
* Static analysis tool configurations
82
87
* Pre-commit hook configurations
83
88
84
89
` INTEGRATION/ ` : AI tool-specific integration guides
90
+
85
91
* GitHub Copilot workspace configuration
86
92
* Custom GPT instructions and prompts
87
93
* IDE plugin configurations
@@ -90,6 +96,7 @@ Create a `innersource-ai/` folder in the repository root containing:
90
96
##### Advanced Features
91
97
92
98
` EMBEDDINGS/ ` (Optional): For advanced LLM integrations
99
+
93
100
* Searchable knowledge base of project patterns
94
101
* Vector embeddings of code examples
95
102
* Semantic search capabilities for finding relevant patterns
@@ -101,12 +108,14 @@ Create a `innersource-ai/` folder in the repository root containing:
101
108
### Usage Patterns
102
109
103
110
#### For Contributors
111
+
104
112
* ** Before Starting** : Review the AI context package to understand project standards
105
113
* ** During Development** : Reference specific files when prompting AI tools
106
114
* ** Code Generation** : Include relevant context snippets in AI prompts
107
115
* ** Validation** : Use provided examples to verify AI-generated code aligns with standards
108
116
109
117
#### For AI Tool Integration
118
+
110
119
* ** Direct Reference** : Copy relevant sections into AI tool prompts
111
120
* ** URL Integration** : Reference files via repository URLs in AI tools that support web access
112
121
* ** IDE Integration** : Configure AI plugins to automatically include context
0 commit comments