Skip to content

Commit 8c4e18a

Browse files
committed
Fix formatting of the remaining bullet lists
1 parent a680729 commit 8c4e18a

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@ With the growing use of AI tools (like GitHub Copilot, ChatGPT, or custom LLMs),
1212

1313
## Context
1414

15-
- InnerSource adoption is in place across the organisation.
16-
- Developers are encouraged to use AI tools to improve their productivity.
17-
- Contributors may not be familiar with or fail to meticulously prompt when generating code through AI, using the target codebase's idioms, architecture, or constraints.
18-
- Maintainers want to empower contributors using AI while preserving code consistency and maintainability.
19-
- Multiple teams are contributing to shared repositories with varying levels of familiarity with project standards.
20-
- Code review processes are becoming bottlenecked by AI-generated code that requires significant rework.
15+
* InnerSource adoption is in place across the organisation.
16+
* Developers are encouraged to use AI tools to improve their productivity.
17+
* Contributors may not be familiar with or fail to meticulously prompt when generating code through AI, using the target codebase's idioms, architecture, or constraints.
18+
* Maintainers want to empower contributors using AI while preserving code consistency and maintainability.
19+
* Multiple teams are contributing to shared repositories with varying levels of familiarity with project standards.
20+
* Code review processes are becoming bottlenecked by AI-generated code that requires significant rework.
2121

2222
## Forces
2323

24-
- **AI Model Limitations**: AI models generate code based on generalized training data, not project-specific patterns, leading to generic solutions that may not fit the project's architecture
25-
- **Knowledge Gap**: New contributors using AI tools might unknowingly bypass existing architectural norms, coding standards, and established patterns
26-
- **Review Overhead**: AI-assisted PRs can significantly increase review load if not aligned with existing practices, as maintainers must spend time explaining and correcting deviations
27-
- **Productivity vs. Quality Trade-off**: While AI tools boost individual productivity, they can reduce overall team productivity if the generated code requires extensive rework
28-
- **Context Switching Cost**: Developers benefit from AI tools only when they have the right contextual grounding, but manually providing this context for each AI interaction is time-consuming
29-
- **Inconsistent Standards**: Different AI tools and different prompting approaches by contributors can lead to wildly inconsistent code styles and patterns
30-
- **Maintenance Burden**: Creating and maintaining the comprehensive AI context requires ongoing effort from maintainers
31-
- **Tool Integration Complexity**: Different AI tools have different ways of consuming context, making it challenging to create universal guidance
32-
- **AI Tool Cost Constraints**: Comprehensive AI context increases processing costs (AI tools charge based on "tokens" \* units of text measurement) and usage limits, requiring strategic balance between context completeness and efficiency
24+
* **AI Model Limitations**: AI models generate code based on generalized training data, not project-specific patterns, leading to generic solutions that may not fit the project's architecture
25+
* **Knowledge Gap**: New contributors using AI tools might unknowingly bypass existing architectural norms, coding standards, and established patterns
26+
* **Review Overhead**: AI-assisted PRs can significantly increase review load if not aligned with existing practices, as maintainers must spend time explaining and correcting deviations
27+
* **Productivity vs. Quality Trade-off**: While AI tools boost individual productivity, they can reduce overall team productivity if the generated code requires extensive rework
28+
* **Context Switching Cost**: Developers benefit from AI tools only when they have the right contextual grounding, but manually providing this context for each AI interaction is time-consuming
29+
* **Inconsistent Standards**: Different AI tools and different prompting approaches by contributors can lead to wildly inconsistent code styles and patterns
30+
* **Maintenance Burden**: Creating and maintaining the comprehensive AI context requires ongoing effort from maintainers
31+
* **Tool Integration Complexity**: Different AI tools have different ways of consuming context, making it challenging to create universal guidance
32+
* **AI Tool Cost Constraints**: Comprehensive AI context increases processing costs (AI tools charge based on "tokens" \* units of text measurement) and usage limits, requiring strategic balance between context completeness and efficiency
3333

3434
## Solution
3535

@@ -75,7 +75,7 @@ Create an `innersource-ai/` folder in the repository root containing:
7575
* `good-examples/`: Well-written code snippets with explanations
7676
* `bad-examples/`: Common mistakes with explanations of why they're problematic
7777
* `refactoring-examples/`: Before/after code showing proper improvements
78-
* Template files for common patterns (controllers, services, utilities)
78+
* Template files for common patterns (controllers, services, utilities)git
7979

8080
##### Configuration and Tooling
8181

@@ -148,8 +148,8 @@ This solution balances the productivity benefits of AI tools with the quality re
148148

149149
## Status
150150

151-
- Initial
152-
- Drafted in August 2025
151+
* Initial
152+
* Drafted in August 2025
153153

154154
## Authors
155155

0 commit comments

Comments
 (0)