Contributing

RDS is open source. Every contribution — big or small — makes it better.

Ways to Contribute

Report a bug

Open a GitHub issue with steps to reproduce.

Suggest a component

Open a discussion with your use case.

Improve docs

Fix typos, clarify examples, add missing props.

Submit a PR

Build a component or fix a bug yourself.

Open a GitHub issue →

Development Setup

bash
# 1. Fork and clone the repogit clone https://github.com/YOUR_USERNAME/rds.gitcd rds# 2. Install dependenciesnpm install# 3. Start the dev servernpm run dev

Open http://localhost:3000 to see the docs site.

PR Guidelines

Before opening a PR, make sure your contribution:

  • Follows the existing component file structure
  • Includes a working usage example
  • Has TypeScript types with an exported props interface
  • Includes or updates the relevant doc page
  • Is added to the sidebar navigation

Component Submission Checklist

  • Based on shadcn/ui if applicable (or clearly documents why not)
  • TypeScript with exported Props interface
  • JSDoc comment on each prop
  • Doc page at src/app/elements/[category]/[name]/page.tsx
  • Added to sidebar nav

Code of Conduct

We follow the Contributor Covenant. Be kind, be constructive, be helpful.

New to open source? Issues labeled good first issue are a great place to start. View open issues →