Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (32 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.68 KB
Raw

Contributing to agentic-kit

Thanks for helping improve the reference library for AI agent UI patterns. Contributions that match the product intent and design system are especially welcome.

What we're looking for

  • New interaction patterns aligned with agentic-ux.com specs
  • Fixes to pattern demos, accessibility, and copy-paste snippets
  • Documentation improvements
  • Site shell polish that stays true to the brand (see design.md)

Development setup

Requires Node.js 20+ and pnpm.

pnpm install
pnpm dev      # start the dev server
pnpm lint     # eslint
pnpm build    # type-check + production build
pnpm preview  # preview the production build

Adding a pattern

  1. Create src/patterns/MyPattern.tsx with a *Demo component and exported *Code string.
  2. Register the pattern in src/lib/patterns.ts.
  3. Keep the copied snippet self-contained — inline styles, no Tailwind in exported code.
  4. Respect prefers-reduced-motion with meaningful fallbacks.
  5. Link back to the relevant agentic-ux spec.

See the README for the full project structure.

Pull request guidelines

  • One pattern or focused change per PR.
  • Run pnpm lint and pnpm build before opening.
  • Include a screenshot or short screen recording for visible UI changes.
  • Note any accessibility considerations (keyboard, focus, contrast, reduced motion).

Commit messages

Use short, imperative subject lines: Add streaming caret pattern, Fix focus trap in context panel.

Code of conduct

This project follows the Contributor Covenant. By participating, you agree to uphold it.