mirror of
https://github.com/PR0M3TH3AN/TORCH.git
synced 2026-10-27 07:51:52 +00:00
3.4 KiB
3.4 KiB
AGENTS.md
Repository-wide operating instructions for autonomous and semi-autonomous coding agents.
Goal
Make this repository portable across many downstream projects. Default to generic guidance, minimal assumptions, and workflows that work in different languages, runtimes, and deployment environments.
Session startup checklist (run every session)
- Read
AGENTS.md(this file). - Read
CLAUDE.mdfor execution workflow and handoff protocol details. - Read
CONTRIBUTING.mdfor commit/PR expectations. - Read
KNOWN_ISSUES.mdfor active blockers and workarounds. - Read
docs/agent-handoffs/README.md. - Review recent notes in:
docs/agent-handoffs/learnings/docs/agent-handoffs/incidents/
Repo-agnostic defaults
- Do not hardcode company, product, team, customer, or environment-specific assumptions.
- Prefer neutral terms such as
project,service,integration,consumer,provider, andenvironment. - Do not assume a specific infrastructure model (local machine, container, CI, cloud VM, etc.) unless explicitly configured in repo files.
- Add project-specific details only when required by the current repository and clearly label them as repository-specific.
Decision and implementation policy
- Start with the smallest safe change that satisfies the request.
- Keep edits focused; avoid unrelated refactors.
- Prefer explicit commands and documented behavior over implicit assumptions.
- Preserve backward compatibility unless the task explicitly permits a breaking change.
- If assumptions are necessary, record them in the final summary.
Validation baseline
- Run the most relevant checks for changed files (tests, lint, typecheck, build, or targeted scripts).
- If a check cannot run, record:
- command attempted,
- reason it could not complete,
- fallback validation performed.
- Never claim a check passed unless it was actually executed.
Agent knowledge-sharing protocol
Capture reusable context so future agents can continue without rediscovery.
What belongs where
KNOWN_ISSUES.md- Active and reproducible issues only.
- Include status, impact, workaround, and last verification date.
docs/agent-handoffs/learnings/- Proven patterns, repeatable fixes, and successful implementation guidance.
docs/agent-handoffs/incidents/- Failures, root causes, mitigations, and prevention guidance.
File naming standard (generic)
Use descriptive, repository-agnostic note names:
YYYY-MM-DD-short-topic.md
Good examples:
2026-02-14-validation-before-summary.md2026-02-14-missing-baseline-context.md
Avoid tool, product, customer, or team names in filenames unless absolutely required for clarity.
Required note sections
Every learning or incident note should include these headings:
- Context
- Observation
- Action taken
- Validation performed
- Recommendation for next agents
Update decision tree
When you discover new reusable context:
- Check if an existing note already covers it.
- If yes, update the existing note.
- If no, add a new note in
learnings/orincidents/using the naming standard above. - If the issue is still active/reproducible, add or update an entry in
KNOWN_ISSUES.md.
Priority order for conflicting instructions
- System/developer/user instructions in the active session
AGENTS.mdCLAUDE.mdCONTRIBUTING.md- Inline code comments and prompt templates