Skip to content

docs(agents): Trim noise from root and tests AGENTS.md#116875

Merged
JoshFerge merged 1 commit into
masterfrom
docs/trim-root-tests-agents-md
Jun 4, 2026
Merged

docs(agents): Trim noise from root and tests AGENTS.md#116875
JoshFerge merged 1 commit into
masterfrom
docs/trim-root-tests-agents-md

Conversation

@JoshFerge

@JoshFerge JoshFerge commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Continues the AGENTS.md cleanup (#116868, #116874), applying the same category-1 (slogans that don't change agent behavior) and category-2 (cheaply re-derivable / drifts when duplicated) cuts to the root and tests guides. 40 deletions, no additions, no actionable rule removed.

Changes

  • AGENTS.md — dropped the generic Overview blurb (no instruction) and the Project Structure ASCII tree (re-derivable by listing the repo, and it goes stale as directories move).
  • tests/AGENTS.md — dropped the generic best-practice bullets (use pytest fixtures, mock external services, test database isolation, use factories for test data — the last already covered in depth by the dedicated factories section), keeping the non-obvious LocalProducer / MemoryMessageStorage note. Also removed the Rule Enforcement closing block ("these rules are MANDATORY… cause CI failures…"), which is pure exhortation.

Draft

Opened as draft for review of the judgment calls before merge — in particular the trimmed Python Tests bullets. Skill-extraction and static/AGENTS.md (844 lines) remain for follow-ups.

🤖 Generated with Claude Code

Agent transcript: https://claudescope.sentry.dev/share/o8s3zz5HXT94ZXAy62YxyKNJgZDOzymMZL2gencSX98

Same category-1 (slogan) and category-2 (re-derivable) cuts applied to
src/AGENTS.md previously.

- AGENTS.md: drop the generic Overview blurb and the Project Structure
  ASCII tree (re-derivable by listing the repo, and it drifts as dirs move).
- tests/AGENTS.md: drop the generic best-practice bullets ('use pytest
  fixtures', 'mock external services', etc.) keeping only the non-obvious
  LocalProducer note, and remove the 'Rule Enforcement' slogan block.

No actionable rule is removed.

Co-Authored-By: Claude <noreply@anthropic.com>
@JoshFerge JoshFerge marked this pull request as ready for review June 4, 2026 17:55
@JoshFerge JoshFerge requested a review from a team as a code owner June 4, 2026 17:55
@JoshFerge JoshFerge requested a review from a team June 4, 2026 17:55
@JoshFerge JoshFerge merged commit c9b951f into master Jun 4, 2026
59 checks passed
@JoshFerge JoshFerge deleted the docs/trim-root-tests-agents-md branch June 4, 2026 17:57
JoshFerge added a commit that referenced this pull request Jun 4, 2026
)

## Summary

The category-3 round of the AGENTS.md cleanup (#116868, #116874,
#116875, #116876). Replaces the ~370-line layout/typography guide in
`static/AGENTS.md` — a near-verbatim **subset** of the `design-system`
skill — with a compact rules summary plus a pointer to the skill. **264
deletions, file goes 844 → 592 lines.**

## The key design constraint
Skills are **request-triggered, not file-triggered**: editing
`static/app/foo.tsx` does *not* auto-load the `design-system` skill,
whereas `static/AGENTS.md` *is* always in context for the subtree. The
big rules here ("use Flex not styled div", "no intrinsic headings") are
also **not** lint-enforced. So this is **not** a "delete and rely on the
skill" change — the *rules stay inline* (as a short bullet list); only
the bulky per-primitive examples and prop reference move to the skill,
where they already live in greater depth (token tables,
`InfoTip`/`InfoText`, full prop lists, a checklist).

## What changed
- **Replaced** (subset of `.agents/skills/design-system/SKILL.md`):
Grid, Flex, Container, the props/responsive/gap "General Guidelines",
Heading, Text, "Splitting layout and typography", and the "Core
components" intro → one `## Design System` section: a skill pointer + 8
rule bullets capturing every rule.
- **Kept inline** (NOT covered by the skill, not lint-enforced): `###
Avatars`, `### Disclosure`, `### Images and Icons` (icon folder, no
inline SVG, `sentry-images` loader). Also dropped the redundant `Assets
→ Image` subsection, which duplicated `Images and Icons`.
- **Untouched**: `General Frontend Rules`, `Frontend API Calls`,
`TanStack Query Type Inference`, and the entire `React Testing
Guidelines` section.

## Coverage check
Every removed rule maps to either a retained bullet in `## Design
System` or the `design-system` skill (verified the skill is a strict
superset of the layout/typography content). The kept subsections were
confirmed absent from the skill.

## Draft
Draft for review — this is the round with the real tradeoff
(trigger-based loading), so worth a careful look at whether the inline
rule summary is sufficient before merge.

🤖 Generated with [Claude Code](https://claude.com/claude-code)


Agent transcript:
https://claudescope.sentry.dev/share/dE3Xyl5aVM7Q8RQmsUja6TlUp9617JozLpZZb-MiQu8

Co-authored-by: Claude <noreply@anthropic.com>
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.

2 participants