agentleFS
muratgurmuratgur/ordinus/.claude/skills/shadcn-project-workflow/SKILL.md

shadcn-project-workflow

Skill111 starsChanged 5 months agoMITView on GitHub

Work with shadcn/ui in Ordinus. Use when adding, updating, composing, debugging, or styling shadcn-style components; touching components.json; using npx shadcn; changing src/renderer/src/components/ui; applying registry items or presets; or deciding whether to install a UI primitive.

The file

Show its rules and text

We split this skill into the rules it gives an agent

18 rules. About 0 are common, 6 are distinctive, and 12 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 12

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use shadcn/ui as the standard path for reusable UI primitives while preserving Ordinus product direction.

    line 10
  2. Very specific:

    Use this with ordinus-ui-system: this skill governs shadcn mechanics.

    line 12
  3. Very specific:

    Use DESIGN.md as the canonical source for theme tokens, component vocabulary, status language, and UI density when changing shadcn-style …

    line 13
  4. Very specific:

    Run or inspect project context before making component decisions: npm run ui:info

    line 17
  5. Very specific:

    Read DESIGN.md before changing theme tokens, variants, component styling, status surfaces, or user-facing UI copy.

    line 19
  6. Distinctive:

    Check existing installed components before adding new ones.

    line 20
  7. Very specific:

    Prefer shadcn CLI for registry components: npm run ui:add -- <component>

    line 21
  8. Distinctive:

    Read files added by the CLI and fix imports, aliases, composition, and lint issues.

    line 28
  9. Very specific:

    Run npm run ui:check, npm run typecheck, npm run lint, and npm run build.

    line 29
  10. Very specific:

    Run shadcn and npm commands from app unless the user explicitly changes the project layout.

    line 36
  11. Distinctive:

    Use built-in variants before custom class overrides.

    line 47
  12. Very specific:

    Use semantic tokens such as bg-background, text-muted-foreground, border, and bg-primary.

    line 48
  13. Distinctive:

    Avoid raw Tailwind colors for product UI unless adding an intentional semantic token or variant.

    line 49
  14. Very specific:

    Use gap-* for spacing, not space-x-* or space-y-*.

    line 50
  15. Very specific:

    Use size-* for equal width and height.

    line 51
  16. Very specific:

    Use cn() for conditional class composition.

    line 52
  17. Distinctive:

    Do not apply presets, overwrite components, or change global theme without explicit user approval.

    line 53
  18. Distinctive:

    Read only the relevant reference when needed:

    line 57

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill 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
SKILL.md

shadcn Project Workflow

Objective

Use shadcn/ui as the standard path for reusable UI primitives while preserving Ordinus product direction.

Use this with ordinus-ui-system: this skill governs shadcn mechanics; ordinus-ui-system governs product feel. Use DESIGN.md as the canonical source for theme tokens, component vocabulary, status language, and UI density when changing shadcn-style components or renderer styling.

Required Workflow

  1. Run or inspect project context before making component decisions: npm run ui:info
  2. Read DESIGN.md before changing theme tokens, variants, component styling, status surfaces, or user-facing UI copy.
  3. Check existing installed components before adding new ones.
  4. Prefer shadcn CLI for registry components: npm run ui:add -- <component>
  5. For unfamiliar components, get docs first: npx shadcn@latest docs <component>
  6. For updates, preview before changing: npm run ui:add -- <component> --dry-run npm run ui:add -- <component> --diff <file>
  7. Read files added by the CLI and fix imports, aliases, composition, and lint issues.
  8. Run npm run ui:check, npm run typecheck, npm run lint, and npm run build.

Ordinus Defaults

  • Package manager: npm.
  • Electron app directory: app.
  • Renderer alias: @renderer/*.
  • Run shadcn and npm commands from app unless the user explicitly changes the project layout.
  • UI components path: app/src/renderer/src/components/ui.
  • Utility path: app/src/renderer/src/lib/utils.ts.
  • Tailwind version: v3.
  • Icon library: lucide-react.
  • Product style: calm, operational, work-focused.

Critical Rules

  • Align reusable variants and semantic CSS variables with DESIGN.md before adding one-off styling.
  • Compose existing components before writing custom styled markup.
  • Use built-in variants before custom class overrides.
  • Use semantic tokens such as bg-background, text-muted-foreground, border, and bg-primary.
  • Avoid raw Tailwind colors for product UI unless adding an intentional semantic token or variant.
  • Use gap-* for spacing, not space-x-* or space-y-*.
  • Use size-* for equal width and height.
  • Use cn() for conditional class composition.
  • Do not apply presets, overwrite components, or change global theme without explicit user approval.

Detailed References

Read only the relevant reference when needed:

  • rules/styling.md for Tailwind and token rules.
  • rules/composition.md for component composition and accessibility.
  • rules/forms.md for forms and validation layouts.
  • rules/icons.md for lucide icon usage.
  • rules/base-vs-radix.md for primitive API differences.
  • references/cli.md for shadcn CLI commands.
  • references/customization.md for theming and CSS variables.

Notes

The official shadcn skill includes broader registry, MCP, asset, and eval infrastructure. Ordinus keeps a smaller adapted version focused on this Electron/Vite app.

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.