mirror of
https://github.com/PR0M3TH3AN/TORCH.git
synced 2026-10-27 07:51:52 +00:00
docs: add generic agent onboarding and handoff guidance
This commit is contained in:
1 parent
1452e3f964
commit
8d5e7e0220
8 files changed
+211
-3
No files matched your search
@@ -0,0 +1,19 @@
|
||||
# Agent Handoffs
|
||||
|
||||
This folder stores reusable learnings that help future agents work faster and safer.
|
||||
|
||||
## Folders
|
||||
|
||||
- `learnings/`: patterns that worked and can be reused.
|
||||
- `incidents/`: failures, root causes, and prevention notes.
|
||||
|
||||
## Filename format
|
||||
|
||||
Use: `YYYY-MM-DD-short-topic.md`
|
||||
|
||||
Examples:
|
||||
|
||||
- `2026-02-14-command-ordering.md`
|
||||
- `2026-02-14-lock-timeout-regression.md`
|
||||
|
||||
Keep names generic and descriptive.
|
||||
@@ -0,0 +1,7 @@
|
||||
# Example Incident: Missing Baseline Context
|
||||
|
||||
- **Context:** Agent started editing without reviewing policy files first.
|
||||
- **Observation:** Resulting patch required rework to match repo standards.
|
||||
- **Action taken:** Re-read policy docs, reverted conflicting edits, reapplied changes correctly.
|
||||
- **Validation performed:** Compared final output to policy docs and reran checks.
|
||||
- **Recommendation for next agents:** Read `AGENTS.md` and `CLAUDE.md` first on every run to avoid avoidable churn.
|
||||
@@ -0,0 +1,7 @@
|
||||
# Example Learning: Validation Before Summary
|
||||
|
||||
- **Context:** Multi-file documentation update.
|
||||
- **Observation:** Running quick checks before writing summaries catches avoidable mistakes.
|
||||
- **Action taken:** Ran status and diff checks before finalizing.
|
||||
- **Validation performed:** Confirmed expected files changed and no accidental edits were included.
|
||||
- **Recommendation for next agents:** Always run at least one verification command after edits and before committing.
|
||||
Reference in new issue
Block a user