Skip to content

Commit 047a8fb

Browse files
committed
Annotate context-store tree in AI context doc
1 parent 22eabef commit 047a8fb

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

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

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,23 +51,27 @@ Provide an **AI Code Generation Context** folder within the repository to guide
5151

5252
Create a `context-store/` folder in the repository root containing:
5353

54-
```text
54+
```code
5555
context-store/
56-
├── README.md
57-
├── PROMPT.md
58-
├── ARCHITECTURE.md
59-
├── contexts/
60-
│ ├── coding-style.md
61-
│ ├── testing.md
62-
│ ├── security.md
63-
│ └── domain-guidelines.md
64-
├── CONFIG/
56+
├── README.md # How contributors should use this context store
57+
├── PROMPT.md # Reusable AI prompt templates
58+
├── ARCHITECTURE.md # Lightweight system overview
59+
60+
├── contexts/ # Detailed project conventions
61+
│ ├── coding-style.md # Naming, formatting, and code organization
62+
│ ├── testing.md # Testing strategy, tools, and expectations
63+
│ ├── security.md # Security guidelines and common risks
64+
│ └── domain-guidelines.md # Project-specific business or domain rules
65+
66+
├── CONFIG/ # Optional shared tooling configuration
6567
│ ├── .editorconfig
6668
│ └── formatter-config
67-
├── INTEGRATION/
69+
70+
├── INTEGRATION/ # Optional AI tool setup guidance
6871
│ ├── copilot.md
6972
│ └── ide-setup.md
70-
└── EMBEDDINGS/
73+
74+
└── EMBEDDINGS/ # Optional advanced retrieval assets
7175
└── README.md
7276
```
7377

0 commit comments

Comments
 (0)