blob: 16c8f5b474f441fb28b9b5705eee5e946991fdcd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
# LLM Notes Folder
This folder is for comprehensive notes taken by AI agents after each major change to the codebase.
## Purpose
- Document learnings, insights, and decisions made during development
- Track architectural changes, bug fixes, and feature implementations
- Provide context for future agents or developers
- Maintain a knowledge base of the project's evolution
## Guidelines for Agents
- Create a new markdown file for each major change (e.g., `2025-01-07-feature-x.md`)
- Include: what was changed, why, challenges faced, solutions, and lessons learned
- Be thorough but concise; aim for 200-500 words per note
- Use consistent naming: `YYYY-MM-DD-brief-description.md`
- Reference related files, commits, or issues
## Template
```
# [Change Title]
## Summary
Brief overview of the change.
## What Was Changed
Detailed description of modifications.
## Why This Change
Rationale and benefits.
## Challenges & Solutions
Problems encountered and how they were resolved.
## Learnings
Key insights, best practices discovered, or future considerations.
## Related
- Files: list
- Commits: hash
- Issues: links
```
|
