Skip to content

docs(agents): consolidate AGENTS.md and align skills with latest prompt guidelines - #196

Merged
overtrue merged 1 commit into
mainfrom
overtrue/agents-md-update-64a3a9
Aug 5, 2026
Merged

docs(agents): consolidate AGENTS.md and align skills with latest prompt guidelines#196
overtrue merged 1 commit into
mainfrom
overtrue/agents-md-update-64a3a9

Conversation

@overtrue

@overtrue overtrue commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Description

A round of optimization over all agent prompts and skills to match current LLM prompt/skill authoring guidelines (concise, non-redundant, imperative, accurate to the repo).

AGENTS.md (327 → 135 lines):

  • Deduplicated: quality-check rules appeared 3×, testing rules 3× (two concatenated documents); generic template boilerplate removed. All substantive project rules preserved.
  • Commands corrected to real package.json scripts: pnpm type-check (runs theme overrides + tsc) instead of pnpm tsc --noEmit; added pnpm format:check.
  • Documented a real pitfall: test:run only picks up tests/lib/*.test.{js,ts} — suites elsewhere silently never run.
  • New rules: before/after screenshot diffs required in PRs for user-visible changes; multi-role adversarial verification (Reviewer / Tester / UX auditor / Simplifier); code must be concise and elegant; unified UI visual language and interaction best practices.
  • nextjs-agent-rules block kept byte-identical.

skills/ui-audit/SKILL.md: quality gates aligned with repo scripts (incl. nvm use v22); vague "preferred browser automation surface" made concrete; audit captures explicitly reused as the PR screenshot diff.

skills/rustfs-console-design-guide/SKILL.md: reciprocal cross-reference with ui-audit; review-workflow captures tied to the PR screenshot-diff requirement.

Vendored .agents/skills/shadcn/ intentionally untouched (maintained by shadcn CLI).

Verified via an adversarial reviewer pass diffing old vs new AGENTS.md: 5 dropped rules found and restored (TODO-with-issue-number, pnpm start, plan-doc stage format, single responsibility, one-assertion-per-test); commands, frontmatter, cross-referenced paths, and the Next.js block all check out.

Type of Change

  • Documentation update

Testing

  • Unit tests added/updated
  • Manual testing completed

Docs-only change. pnpm prettier --check passes on all three touched files; all referenced commands and file paths verified against package.json and the repo.

Checklist

  • Code follows the project's style guidelines
  • Self-review completed
  • TypeScript types are properly defined (N/A — docs only)
  • All commit messages are in English (Conventional Commits)
  • All existing tests pass (no code touched)
  • No new dependencies added, or they are justified

Related Issues

N/A

Screenshots (if applicable)

N/A — no user-visible UI change.

Additional Notes

None.

…pt guidelines

- Deduplicate AGENTS.md (327 -> 135 lines): merge three overlapping
  quality-check/testing sections, drop generic template boilerplate
- Fix commands to match package.json scripts (pnpm type-check,
  format:check); document that test:run only picks up tests/lib
- Add rules: PR screenshot diffs for user-visible changes, multi-role
  adversarial verification, concise/elegant code, unified UI style
- ui-audit skill: align quality gates with repo scripts, concretize
  browser validation tooling, reuse captures as PR screenshot diffs
- design-guide skill: cross-reference ui-audit and PR screenshot rule
- Keep nextjs-agent-rules block byte-identical; leave vendored shadcn
  skill untouched
Copilot AI review requested due to automatic review settings August 5, 2026 00:09

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@overtrue
overtrue merged commit 5606d0c into main Aug 5, 2026
10 checks passed
@overtrue
overtrue deleted the overtrue/agents-md-update-64a3a9 branch August 5, 2026 00: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.

2 participants