Skip to content

Commit 1fe3163

Browse files
committed
remove extra whitespace ahead of bullet points
1 parent 833e322 commit 1fe3163

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

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

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -43,63 +43,63 @@ Create a `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 organization 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 organization 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
#### Optional Enhancements (Implement As Needed)
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

9898
`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
### Implementation Strategy
105105

@@ -116,27 +116,27 @@ Create a `innersource-ai/` folder in the repository root containing:
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

126-
* **Version Control**: Track changes to AI context alongside code changes
127-
* **Regular Updates**: Review and update context as project standards evolve
128-
* **Community Contribution**: Allow contributors to suggest improvements to AI context
129-
* **Metrics Tracking**: Monitor the effectiveness of AI context through code review metrics
126+
* **Version Control**: Track changes to AI context alongside code changes
127+
* **Regular Updates**: Review and update context as project standards evolve
128+
* **Community Contribution**: Allow contributors to suggest improvements to AI context
129+
* **Metrics Tracking**: Monitor the effectiveness of AI context through code review metrics
130130

131131
## Resulting Context
132132

133-
* **Improved Code Quality**: AI-assisted contributions become consistent with existing code standards and architectural patterns from the first submission
134-
* **Reduced Review Friction**: Maintainers can trust incoming PRs more readily, significantly reducing review fatigue and time-to-merge
135-
* **Enhanced Contributor Experience**: Contributors using AI produce better, more maintainable code even on their first attempts, leading to increased confidence and participation
136-
* **Scalable Collaboration**: Opens the door to scalable, AI-aware InnerSource collaboration across teams without sacrificing code quality
137-
* **Knowledge Preservation**: Project knowledge becomes more explicit and accessible, reducing dependency on tribal knowledge
138-
* **Faster Onboarding**: New contributors can leverage AI tools effectively from day one, reducing the learning curve for project-specific patterns
139-
* **Consistent Evolution**: As AI tools improve, the context package ensures that enhanced capabilities are channeled toward project-appropriate solutions
133+
* **Improved Code Quality**: AI-assisted contributions become consistent with existing code standards and architectural patterns from the first submission
134+
* **Reduced Review Friction**: Maintainers can trust incoming PRs more readily, significantly reducing review fatigue and time-to-merge
135+
* **Enhanced Contributor Experience**: Contributors using AI produce better, more maintainable code even on their first attempts, leading to increased confidence and participation
136+
* **Scalable Collaboration**: Opens the door to scalable, AI-aware InnerSource collaboration across teams without sacrificing code quality
137+
* **Knowledge Preservation**: Project knowledge becomes more explicit and accessible, reducing dependency on tribal knowledge
138+
* **Faster Onboarding**: New contributors can leverage AI tools effectively from day one, reducing the learning curve for project-specific patterns
139+
* **Consistent Evolution**: As AI tools improve, the context package ensures that enhanced capabilities are channeled toward project-appropriate solutions
140140

141141
## Rationale
142142

0 commit comments

Comments
 (0)