Skip to content

docs(agents): policy updates — uv tooling, GPU caveat, Conventional Commits, no AI attribution#110

Merged
h-tonywu merged 4 commits into
mainfrom
docs-agents-policy
Jun 10, 2026
Merged

docs(agents): policy updates — uv tooling, GPU caveat, Conventional Commits, no AI attribution#110
h-tonywu merged 4 commits into
mainfrom
docs-agents-policy

Conversation

@tonywu71

@tonywu71 tonywu71 commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Context

AGENTS.md's checklist used bare ruff/pytest commands instead of CONTRIBUTING.md's uv run tooling, and nothing covered the GPU-validation gap (CUDA tests auto-skip locally, so local green doesn't validate kernel changes), the pre-PR docs sweep requirement, or the H100 benchmark-validation and GPU-CI protocol that #109 proved necessary. Two policies were also implicit but unwritten: Conventional Commits format and no AI attribution in commits or PR text.

Separated from #108 (doc accuracy sweep). These are policy additions, not doc-drift corrections.

Changes

Click here to expand
  • AGENTS.md — commands updated to uv run invocations; pre-PR docs sweep step added (check how-it-works.html, design.md, README tables for invalidated claims); H100 bench-validation and run-gpu-tests GPU-CI protocol added; Conventional Commits (type(scope): subject) required; AI attribution banned in commits, PR descriptions, and PR comments. Condensed from 108 to 33 lines.
  • CLAUDE.md — new file with a one-line @AGENTS.md import. Claude Code reads only CLAUDE.md; the @ import applies the shared agent rules without a symlink (cross-platform, the documented pattern).
  • .gitignore — ignores .claude/worktrees/ (ephemeral agent worktrees).

Validation

No code changes; no test run required.

tonywu71 added 4 commits June 10, 2026 09:36
The checklist commands didn't match CONTRIBUTING.md's uv-managed
invocations, implied a green local pytest validates kernel changes
(CUDA tests auto-skip without a GPU), and said nothing about keeping
the prose docs in sync with the code — the source of most of the doc
drift this PR fixes.
Half the file was explanation around rules agents already follow once
stated. Keep one line per rule, add the H100 bench-validation and
GPU-CI-label protocol that PR #109 proved necessary, require
Conventional Commits, and ban AI attribution in commits and PRs.
Claude Code reads only CLAUDE.md; the @AGENTS.md import is the
documented way to apply the shared agent rules there (symlinks need
admin rights on Windows and leave no room for Claude-specific notes).
@h-tonywu h-tonywu self-assigned this Jun 10, 2026
@h-tonywu h-tonywu added the documentation Improvements or additions to documentation label Jun 10, 2026
@h-tonywu h-tonywu merged commit a69d18e into main Jun 10, 2026
4 checks passed
@h-tonywu h-tonywu deleted the docs-agents-policy branch June 10, 2026 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants