mirror of
https://github.com/PR0M3TH3AN/TORCH.git
synced 2026-10-27 07:51:52 +00:00
1.0 KiB
1.0 KiB
CONTRIBUTING
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 repo-specific requirements.
Before opening a PR
- Confirm instructions in
AGENTS.mdandCLAUDE.mdwere followed. - Run relevant checks/tests.
- Update docs affected by behavior changes.
- If you discovered reusable information, add/update a note under
docs/agent-handoffs/.
Commit guidance
- Use clear, descriptive commit messages.
- Keep unrelated edits in separate commits.
- Avoid committing temporary debug code or local-only artifacts.
PR guidance
Include:
- Summary of what changed
- Why it changed
- Validation performed
- Any known follow-ups
If no tests were run, state why.
Documentation maintenance
When changing workflows:
- Update
KNOWN_ISSUES.mdfor new known limitations/workarounds. - Add a learning note if the change uncovered a reusable pattern.