agentleFS
saleorsaleor/saleor-dashboard/AGENTS.md

saleor-dashboard

AGENTS.md1.1k starsChanged 8 days agoBSD-3-ClauseView on GitHub

- Use @saleor/macaw-ui-next components and tokens; do not add usages of legacy @saleor/macaw-ui, Material-UI, or makeStyles. - Import icons directly from lucide-react; Macaw icons are deprecated. - Use CSS Modules (.module.css) for custom styles. - Write new code with strict TypeScript checking; do not add // @ts-strict-ignore. - Use named exports and direct imports. Do not introduce barrel exports; route entry points named index.tsx are allowed. - Prefer destructured object parameters and typed declarations over type assertions. Explicitly type test…

  • Reads credentials

Trending

Less talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 3 mentionsMar 2026: 5 mentionsApr 2026: 0 mentionsMay 2026: 1 mentionJun 2026: 33 mentionsJul 2026: 3 mentionsAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 2 mentionsNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the saleor/saleor-dashboard repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about saleor/saleor-dashboard

The biggest 5 of 50 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 50

Talked about on GitHub (50 times).

On GitHub · 50

45 more on GitHub

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

25 rules. About 0 are common, 8 are distinctive, and 17 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 17

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Very specific:

    Use @saleor/macaw-ui-next components and tokens.

    line 5
  2. Very specific:

    Import icons directly from lucide-react.

    line 7
  3. Very specific:

    Use CSS Modules (.module.css) for custom styles.

    line 8
  4. Very specific:

    Write new code with strict TypeScript checking.

    line 9
  5. Very specific:

    Use named exports and direct imports.

    line 10
  6. Distinctive:

    Prefer destructured object parameters and typed declarations over type assertions.

    line 12
  7. Very specific:

    Add a colocated ComponentName.stories.tsx for new UI components.

    line 16
  8. Distinctive:

    Read documentation when its subject is relevant to the task:

    line 25
  9. Distinctive:

    Use its dashboard-facing names even when API names differ.

    line 28
  10. Very specific:

    Read current commands, dependencies, and runtime requirements from package.json, including packageManager and engines.

    line 37
  11. Very specific:

    Put dependency overrides in pnpm-workspace.yaml under overrides, never in package.json under pnpm.overrides.

    line 44
  12. Very specific:

    After changing GraphQL operations, fragments, or schemas, run pnpm run generate for both main and staging schemas.

    line 46
  13. Very specific:

    After changing react-intl messages, run pnpm run extract-messages.

    line 48
  14. Very specific:

    Run pnpm run dev in the background.

    line 51
  15. Very specific:

    Use pnpm run test:quiet <file_path> for individual Jest files.

    line 65
  16. Distinctive:

    Add or update unit tests for changed utility behavior and complex components.

    line 67
  17. Very specific:

    When changing dependencies, exports, or file organization, run pnpm run knip.

    line 69
  18. Distinctive:

    Do not manually merge generated content.

    line 81
  19. Distinctive:

    When adding a substantial product feature, implement PostHog tracking for its key user interactions and outcomes, following existing …

    line 90
  20. Distinctive:

    Do not add tracking for bug fixes, removals, refactors, or other maintenance-only changes.

    line 92
  21. Distinctive:

    Use the changesets CLI for user-facing features, enhancements, and bug fixes.

    line 96
  22. Very specific:

    Follow scope policy in .github/CONTRIBUTING.md (Pull requests section) and title and description requirements in …

    line 99
  23. Very specific:

    Run the saleor-dashboard-pr-quality-check skill when planning (to keep the planned scope to one PR) and when work is done, including after …

    line 101
  24. Very specific:

    Prefer the gh CLI for GitHub operations.

    line 105
  25. Very specific:

    No agent-driven issue tracker is configured.

    line 106

≈ “Common” is an estimate: at least 1 in 5 of the 42,283 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Saleor Dashboard

Conventions

  • Use @saleor/macaw-ui-next components and tokens; do not add usages of legacy @saleor/macaw-ui, Material-UI, or makeStyles.
  • Import icons directly from lucide-react; Macaw icons are deprecated.
  • Use CSS Modules (.module.css) for custom styles.
  • Write new code with strict TypeScript checking; do not add // @ts-strict-ignore.
  • Use named exports and direct imports. Do not introduce barrel exports; route entry points named index.tsx are allowed.
  • Prefer destructured object parameters and typed declarations over type assertions. Explicitly type test fixtures.
  • Internationalize user-facing text with react-intl. Check src/intl.ts and nearby component messages for reusable messages before defining new ones.
  • Add a colocated ComponentName.stories.tsx for new UI components.
  • In tests, use // Arrange, // Act, and // Assert comments. Mock GraphQL operations with typed fixtures.
  • For lists that can contain 50+ items, keep navigation and controls usable and selected items discoverable. Choose scrolling, pagination, or virtualization to suit the component. Use skeletons for loading and handle empty states.

Task-specific context

Read documentation when its subject is relevant to the task:

  • CONTEXT.md for product terminology, especially modeling and navigation pins. Use its dashboard-facing names even when API names differ.
  • Relevant decisions in docs/adr/ when changing the behavior they govern. Surface conflicts with those decisions rather than silently overriding them.
  • docs/multi-schema.md for GraphQL operations, generation, or schema selection.
  • docs/configuration.md and .env.template when configuring or running the app.
  • docs/running-tests.md when running Playwright tests.
  • .claude/skills/saleor-dashboard-cloud-extensions/SKILL.md when touching src/cloud-extensions or the submodule pointer.

Read current commands, dependencies, and runtime requirements from package.json, including packageManager and engines; read aliases from tsconfig.json.

Conditional workflows

  • Install dependencies when missing or when dependency inputs change. Run pnpm install after modifying package.json or workspace dependency settings.
  • Put dependency overrides in pnpm-workspace.yaml under overrides, never in package.json under pnpm.overrides.
  • After changing GraphQL operations, fragments, or schemas, run pnpm run generate for both main and staging schemas. Do not hand-edit .generated.ts files.
  • After changing react-intl messages, run pnpm run extract-messages.
  • Set up a backend only when the task needs a running application or integration tests. Setup and code generation are not prerequisites for unrelated edits.
  • Run pnpm run dev in the background. If background execution is unavailable, ask the user how to proceed. Its predev hook already runs code generation.

Verification

Match verification to the affected code. Complete relevant checks before handing back implementation work, and report any checks that could not run.

  • Documentation-only changes: format the changed files with oxfmt; application tests, type checks, and knip are unnecessary.
  • Code changes: run oxlint with auto-fix and oxfmt on the changed files before manually fixing lint errors. ESLint only runs GraphQL rules (eslint.config.mjs); run it on changed GraphQL operations. Run affected tests and the relevant check-types:* scripts from package.json.
  • Use pnpm run test:quiet <file_path> for individual Jest files. Switch to pnpm run test:debug <file_path> when debugging requires console or DOM output.
  • Add or update unit tests for changed utility behavior and complex components; use Playwright coverage for critical user flows.
  • When changing dependencies, exports, or file organization, run pnpm run knip.
  • For changes spanning application code, Playwright, and scripts, run pnpm run check-types. Use pnpm run lint for repository-wide lint, formatting, and changeset validation; it auto-fixes and formats files across the repository.
  • Rerun affected checks after fixes. Broaden verification when shared behavior, configuration changes, or failures warrant it; avoid repeating successful checks without new changes or evidence.

Conflict resolution and review

  • Resolve source conflicts first, then regenerate derived files: pnpm install for pnpm-lock.yaml, and pnpm run generate for GraphQL outputs. Do not manually merge generated content.
  • Resolve package-version conflicts against intended dependency constraints and preserve deliberate pins. Do not turn conflict resolution into an unrelated upgrade to the latest registry release.
  • During code review, skip inspecting .generated.ts contents; review the source operations and generation configuration instead.

Analytics

  • When adding a substantial product feature, implement PostHog tracking for its key user interactions and outcomes, following existing analytics patterns.
  • Do not add tracking for bug fixes, removals, refactors, or other maintenance-only changes.

Contributions

  • Use the changesets CLI for user-facing features, enhancements, and bug fixes. Explain the user-visible behavior; for fixes, describe what failed and what works now. Skip changesets for internal refactors, style, tests, CI/CD, and internal docs.
  • Follow scope policy in .github/CONTRIBUTING.md (Pull requests section) and title and description requirements in .github/PULL_REQUEST_TEMPLATE.md.
  • Run the saleor-dashboard-pr-quality-check skill when planning (to keep the planned scope to one PR) and when work is done, including after each commit. Without an open PR it checks the local branch. If it recommends a split, surface that to the user before continuing.
  • Prefer the gh CLI for GitHub operations.
  • No agent-driven issue tracker is configured. Return issue or triage findings in the conversation; see docs/agents/issue-tracker.md when a skill expects a tracker.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.