Skip to content

AGENTS.md

Latest commit

 

History

History
45 lines (30 loc) · 2.47 KB

AGENTS.md

File metadata and controls

45 lines (30 loc) · 2.47 KB
Raw

Agents.md

This file should help you / the agent to focus on the work and understand the purpose of this project.

CRITICAL Memory bank protocol CRITICAL

You must maintain a "memory bank" in the .memory-bank/ directory. This is your source of truth.

  1. before starting any task
  • read product-context.md to understand the goal
  • read active-context.md to see the current focus
  • read system-architecture.md to ensure patterns are followed
  1. during the task
  • if you make architectural changes, you MUST update the system-architecture.md immediately
  1. after completing the task/session
  • add to the progress.md what was accomplished, use ## <current timestamp, YYYY-MM-DD HH:MM format> as header, insert immediately below the # Journal header.
  • IMPORTANT: Execute date '+%Y-%m-%d %H:%M' in terminal to get accurate timestamp instead of guessing
  • update active-context.md with the next logical steps for the next session
  • summarize these updates to the user

⚠️ MANDATORY COMPLETION CHECKLIST ⚠️ Before ending ANY response after making code changes, you MUST: [ ] Append changes to .memory-bank/progress.md with current timestamp [ ] Update .memory-bank/active-context.md if focus/architecture changed [ ] Confirm to user that memory bank has been updated

If you skip this checklist, the session is INCOMPLETE.

CRITICAL Todo workflow CRITICAL

If developer suggest to pick up the next todo item, check the 'Next Steps (unsorted)' section in .memory-bank/active-context.md file and recommend top 3 of best items to pick up.

CRITICAL File creation rules CRITICAL

The create_file tool has a known bug where it can silently duplicate/corrupt file content (e.g. duplicated package declarations, garbled lines). The terminal heredoc approach also mangles long multi-line strings with special characters.

Mandatory workflow for creating new files:

  1. Always verify after creating a file. Immediately after using create_file, run head -5 <file> in the terminal to confirm the first lines are correct — specifically check there is only ONE package declaration.
  2. If corruption is detected: delete the file with rm, then recreate it. Do NOT try to edit a corrupted file in-place.
  3. For Go files specifically: after creation, run go build ./path/to/package/... to confirm compilation before moving on.
  4. Never assume create_file succeeded. Always verify. The cost of checking is near-zero; the cost of building on a corrupted file is high.