Skip to content

Commit df52668

Browse files
authored
feat: add implementation strategy for existing docs - AI Code Generation Context (#840)
* feat: add implementation strategy for existing docs * chore: make folder name consistent * feat: add file name to the naming convention
1 parent 6d624d1 commit df52668

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,9 @@ Create an `innersource-ai/` folder in the repository root containing:
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

106-
**Naming Convention**: The suggested file and folder names follow industry common practices. However, codebase owners may choose alternative names that are more discoverable and relatable to their specific project or codebase. Any chosen naming convention should be clearly documented and communicated to contributors through proper documentation. Should files like [AGENTS.md](https://agents.md) become standard in the future, the naming conventions in this pattern might be adapted accordingly.
106+
**Naming Convention**: The suggested file and folder names follow industry common practices. However, codebase owners may choose alternative names that are more discoverable and relatable to their specific project or codebase. Any chosen naming convention should be clearly documented and communicated to contributors through proper documentation. Should files like [AGENTS.md](https://agents.md) and `.aiignore` become standard in the future, the naming conventions in this pattern might be adapted accordingly.
107+
108+
**Handling Existing Documentation**: If files like `ARCHITECTURE.md` already exist, the pragmatic approach is to keep them in their current location and add lightweight reference files in `innersource-ai` that point to them. When the architecture docs, style guides, or other materials are in Confluence or similar external systems, the `innersource-ai` folder becomes a crucial bridge between the codebase and external knowledge. This avoids duplication and keeps the folder consistent. For projects that want tighter integration, code owners could choose to reorganize and consolidate content under `innersource-ai`, but that requires more effort. The approach is flexible enough to support either approach—or even a hybrid—depending on what works best for the repository.
107109

108110
### Usage Patterns
109111

0 commit comments

Comments
 (0)