memory-md
Installation
SKILL.md
MEMORY.md
Use MEMORY.md as a concise repository-local memory file. It is not automatically loaded, so check for it explicitly at the start of repository conversations and whenever prior project context may matter.
When To Read
- At the start of a repository conversation, check whether
MEMORY.mdexists and skim it for relevant context before planning or editing. - Check it again before non-trivial debugging, design work, workflow changes, or skill maintenance where past project choices may affect the answer.
- Treat a missing
MEMORY.mdas normal. Do not invent entries or assume the file exists. - Use current repository evidence as the source of truth when memory and files disagree.
When To Update
- Add or revise an entry after a mistake, discovery, or user preference when it will help avoid repeating the same issue.
- If an existing
MEMORY.mdentry is wrong, stale, or contradicted by current evidence, correct that entry instead of adding a conflicting note. - Keep entries short, reusable, and grounded in the current repo.
- Never store secrets or sensitive data in
MEMORY.md. This includes credentials, tokens, API keys, cookies, private URLs or endpoints, proprietary/internal-only details that should not be committed, and sensitive personal data. When a gotcha or preference involves such material, record only the minimal sanitized lesson, not the secret or identifying detail itself. - Do not add task logs, transient status, broad summaries, or speculative plans.