Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (33 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.42 KB
Raw

Contributing to Refract Frontend

Thanks for helping build the Refract web app! UI and DX contributions are very welcome.

Ground rules

  • Be respectful — see the Code of Conduct.
  • Discuss larger UI/UX changes in an issue first (a screenshot or sketch helps).
  • Keep the build green: lint, typecheck, and build must pass.

Getting set up

npm install
npm run dev      # http://localhost:3000

Local gate (matches CI)

npm run lint
npm run typecheck
npm run build

Coding standards

  • TypeScript throughout; type component props explicitly.
  • Style with Tailwind utilities and the design tokens defined in src/app/globals.css (--pm-*). Avoid hard-coded hex colors — reuse tokens.
  • Mark interactive client components with "use client".
  • Keep components accessible: semantic elements, labelled controls, visible focus.
  • Prefer composition over deeply nested conditionals in JSX.

What we'd love help with

  • Wallet connection (Freighter / Stellar Wallets Kit) and transaction signing.
  • Wiring pages to live refract-backend endpoints (replace placeholder data).
  • A shared lib/api client and loading/error states.
  • Responsive polish and reduced-motion support.

Commit & PR conventions

  • Conventional Commits: feat:, fix:, style:, docs:, chore:.
  • Include before/after screenshots for visual changes in your PR.