Skip to content

AGENTS.md for repo - #1016

Merged
tsrikris merged 7 commits into
mainfrom
feat/repo_management
Sep 14, 2026
Merged

tsrikris merged 7 commits into
mainfrom
feat/repo_management

Conversation

@tsrikris

@tsrikris tsrikris commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Governance and docs cleanup:

  • AGENTS.md is now the single authoring contract, and CLAUDE.md collapses to
    a one-line pointer at it.
  • Trace-collection guidance moves from the standalone collect-traces.md page
    into the two report docs readers already land on; the orphan page is removed.
  • The Project Structure tree moves from CONTRIBUTING.md into README.md, corrected to match disk.

Changes

  • AGENTS.md / CLAUDE.md. Rewrote AGENTS.md as a lean rules-of-engagement
    contract (change scope, reuse, correctness, hygiene); reduced CLAUDE.md to
    Read [AGENTS.md](AGENTS.md).
  • Trace collection. Capture snippet and profiler-flags table now open
    generate-perf-report-pytorch.md as ## Collect a trace; the sanity-check
    list is now ## Before you trust a report in the inference report doc. Removed
    collect-traces.md and repointed every reference (README.md,
    docs/index.rst, docs/how-to/agent.md, Agent Analysis/README.md) at the
    new #collect-a-trace anchor.
  • Project Structure tree. Moved to README.md, fixing the unclosed-fence bug
    and dead Black ToC entries in CONTRIBUTING.md. Added the missing Agent/,
    TraceIndex/, TraceUtils/, notebooks/, and scripts/ dirs; fixed the tree
    glyph and the GPUEventAnalyser spelling.

@kyle-hoffmeyer

Copy link
Copy Markdown
Collaborator

@tsrikris, I would also consider adding:

"When writing docstrings and code comments, follow surrounding code structure. Don't write unusually long code comments or docstrings"
"When creating utility functions, see if they already exist and reuse when possible. If they don't exist, think about where it should go."
"Keep imports at the top. The only exception is when imports are conditional"

@tsrikris
tsrikris enabled auto-merge (squash) September 14, 2026 16:40
Comment thread CLAUDE.md
@tsrikris
tsrikris merged commit 4dd22f5 into main Sep 14, 2026
3 checks passed
@tsrikris
tsrikris deleted the feat/repo_management branch September 14, 2026 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants