Skip to content

Commit f67991f

Browse files
committed
Fix markdownlint issues
1 parent 0930e21 commit f67991f

1 file changed

Lines changed: 40 additions & 40 deletions

File tree

patterns/1-initial/ai-code-generation-context.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -43,63 +43,63 @@ Create an `innersource-ai/` folder in the repository root containing:
4343

4444
`PROMPT.md`: Project-specific instructions for AI tools
4545

46-
- Naming conventions (variables, functions, classes, files)
47-
- Logging patterns and error handling approaches
48-
- Testing strategy and preferred testing frameworks
49-
- Code formatting and style preferences
50-
- Common anti-patterns to avoid
51-
- Preferred libraries and frameworks for specific tasks
46+
* Naming conventions (variables, functions, classes, files)
47+
* Logging patterns and error handling approaches
48+
* Testing strategy and preferred testing frameworks
49+
* Code formatting and style preferences
50+
* Common anti-patterns to avoid
51+
* Preferred libraries and frameworks for specific tasks
5252

5353
`ARCHITECTURE.md`: Lightweight system overview
5454

55-
- High-level system architecture and component relationships
56-
- Data flow patterns and API design principles
57-
- Dependency management guidelines
58-
- Module organisation and layering principles
59-
- Integration patterns with external systems
55+
* High-level system architecture and component relationships
56+
* Data flow patterns and API design principles
57+
* Dependency management guidelines
58+
* Module organization and layering principles
59+
* Integration patterns with external systems
6060

6161
`STYLE_GUIDE.md`: Comprehensive coding guidelines
6262

63-
- Language-specific style rules
64-
- Code organisation patterns
65-
- Documentation standards
66-
- Performance considerations
67-
- Security guidelines and common vulnerabilities to avoid
63+
* Language-specific style rules
64+
* Code organization patterns
65+
* Documentation standards
66+
* Performance considerations
67+
* Security guidelines and common vulnerabilities to avoid
6868

6969
#### Enhancements (Optional)
7070

7171
##### Practical Examples
7272

7373
`EXAMPLES/`: Sample code files demonstrating best practices
7474

75-
- `good-examples/`: Well-written code snippets with explanations
76-
- `bad-examples/`: Common mistakes with explanations of why they're problematic
77-
- `refactoring-examples/`: Before/after code showing proper improvements
78-
- Template files for common patterns (controllers, services, utilities)
75+
* `good-examples/`: Well-written code snippets with explanations
76+
* `bad-examples/`: Common mistakes with explanations of why they're problematic
77+
* `refactoring-examples/`: Before/after code showing proper improvements
78+
* Template files for common patterns (controllers, services, utilities)
7979

8080
##### Configuration and Tooling
8181

8282
`CONFIG/`: Shared formatter and analysis configurations
8383

84-
- `.prettierrc`, `.eslintrc`, or equivalent formatting configs
85-
- `.editorconfig` for consistent editor settings
86-
- Static analysis tool configurations
87-
- Pre-commit hook configurations
84+
* `.prettierrc`, `.eslintrc`, or equivalent formatting configs
85+
* `.editorconfig` for consistent editor settings
86+
* Static analysis tool configurations
87+
* Pre-commit hook configurations
8888

8989
`INTEGRATION/`: AI tool-specific integration guides
9090

91-
- GitHub Copilot workspace configuration
92-
- Custom GPT instructions and prompts
93-
- IDE plugin configurations
94-
- CLI tool integration examples
91+
* GitHub Copilot workspace configuration
92+
* Custom GPT instructions and prompts
93+
* IDE plugin configurations
94+
* CLI tool integration examples
9595

9696
##### Advanced Features
9797

98-
`EMBEDDINGS/`: For advanced LLM integrations
98+
`EMBEDDINGS/` (Optional): For advanced LLM integrations
9999

100-
- Searchable knowledge base of project patterns
101-
- Vector embeddings of code examples
102-
- Semantic search capabilities for finding relevant patterns
100+
* Searchable knowledge base of project patterns
101+
* Vector embeddings of code examples
102+
* Semantic search capabilities for finding relevant patterns
103103

104104
**Context Efficiency**: Start with core documentation files (~1000 words of context) to balance context value with AI tool costs. Expand strategically based on measured impact on review cycles and code quality.
105105

@@ -109,17 +109,17 @@ Create an `innersource-ai/` folder in the repository root containing:
109109

110110
#### For Contributors
111111

112-
- **Before Starting**: Review the AI context package to understand project standards
113-
- **During Development**: Reference specific files when prompting AI tools
114-
- **Code Generation**: Include relevant context snippets in AI prompts
115-
- **Validation**: Use provided examples to verify AI-generated code aligns with standards
112+
* **Before Starting**: Review the AI context package to understand project standards
113+
* **During Development**: Reference specific files when prompting AI tools
114+
* **Code Generation**: Include relevant context snippets in AI prompts
115+
* **Validation**: Use provided examples to verify AI-generated code aligns with standards
116116

117117
#### For AI Tool Integration
118118

119-
- **Direct Reference**: Copy relevant sections into AI tool prompts
120-
- **URL Integration**: Reference files via repository URLs in AI tools that support web access
121-
- **IDE Integration**: Configure AI plugins to automatically include context
122-
- **Custom Workflows**: Integrate context into CI/CD pipelines for automated validation
119+
* **Direct Reference**: Copy relevant sections into AI tool prompts
120+
* **URL Integration**: Reference files via repository URLs in AI tools that support web access
121+
* **IDE Integration**: Configure AI plugins to automatically include context
122+
* **Custom Workflows**: Integrate context into CI/CD pipelines for automated validation
123123

124124
### Maintenance Strategy
125125

0 commit comments

Comments
 (0)