mirror of
https://github.com/PR0M3TH3AN/TORCH.git
synced 2026-10-27 07:51:52 +00:00
Refactor agent docs to be fully repo-agnostic
This commit is contained in:
1 parent
9170415826
commit
e541053fee
5 files changed
+182
-107
No files matched your search
+21
-12
@@ -5,37 +5,46 @@ Guidelines for humans and agents proposing changes.
|
||||
## Change principles
|
||||
|
||||
- Keep changes focused and minimal.
|
||||
- Explain why a change is needed, not only what changed.
|
||||
- Preserve generic behavior unless implementing explicit downstream repo requirements.
|
||||
- Explain why the change is needed, not only what changed.
|
||||
- Preserve generic behavior unless explicit repository-specific behavior is required.
|
||||
|
||||
## Before opening a PR
|
||||
|
||||
1. Confirm `AGENTS.md` and `CLAUDE.md` were followed.
|
||||
2. Run relevant checks/tests for the scope of change.
|
||||
3. Update docs affected by behavior or workflow changes.
|
||||
4. If you discovered reusable information, add/update a note in `docs/agent-handoffs/`.
|
||||
2. Run relevant checks/tests for the changed scope.
|
||||
3. Update documentation impacted by behavior or workflow changes.
|
||||
4. If reusable knowledge was discovered, update/add a note in `docs/agent-handoffs/`.
|
||||
5. If an issue remains active, update `KNOWN_ISSUES.md`.
|
||||
|
||||
## Commit guidance
|
||||
|
||||
- Use clear, descriptive commit messages.
|
||||
- Keep unrelated edits in separate commits.
|
||||
- Avoid committing temporary debug code or local-only artifacts.
|
||||
- Do not commit temporary debug code, generated noise, or local-only artifacts.
|
||||
|
||||
## PR guidance
|
||||
|
||||
Include:
|
||||
|
||||
- Summary of what changed
|
||||
- What changed
|
||||
- Why it changed
|
||||
- Validation performed
|
||||
- Any known follow-ups
|
||||
- Follow-up items or risks
|
||||
|
||||
If no tests were run, state why.
|
||||
If no tests/checks were run, explicitly state why.
|
||||
|
||||
## Agent handoff expectations
|
||||
|
||||
When your work creates reusable context:
|
||||
|
||||
- Prefer updating an existing handoff note over creating duplicates.
|
||||
- If creating a new note, use `YYYY-MM-DD-short-topic.md`.
|
||||
- Keep notes generic and actionable.
|
||||
- Use the required sections from `docs/agent-handoffs/README.md`.
|
||||
|
||||
## Documentation maintenance
|
||||
|
||||
When changing workflows:
|
||||
When workflows change:
|
||||
|
||||
- Update `KNOWN_ISSUES.md` for new known limitations/workarounds.
|
||||
- Add a learning or incident note if the change uncovered reusable guidance.
|
||||
- Update `KNOWN_ISSUES.md` for newly discovered active limitations/workarounds.
|
||||
- Add/update a learning or incident note for durable guidance.
|
||||
Reference in new issue
Block a user