Skip to content

Commit 8e435b7

Browse files
authored
feat: add implementation strategy for existing docs
1 parent 511db83 commit 8e435b7

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ Create an `innersource-ai/` folder in the repository root containing:
105105

106106
**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.
107107

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 `ai-context` that point to them. When the architecture docs, style guides, or other materials are in Confluence or similar external systems, the `ai-context` 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 `ai-context`, 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.
109+
108110
### Usage Patterns
109111

110112
#### For Contributors

0 commit comments

Comments
 (0)