CONTRIBUTING.md

Contributing to HyperUI

Thanks for helping improve HyperUI.

Before you start

Please open an issue first before starting work.

Run the site locally

git clone git@github.com:markmead/hyperui.git
pnpm install
pnpm dev
pnpm run css:component --watch

To preview the blog styles, execute: pnpm run css:blog.

Submit a contribution

1. Open an issue.
2. Create a branch.
3. Make your change.
4. Open a PR for review.

Issue and PR title format

• Use sentence case for the description part.
• Keep descriptions concise and specific.
• Pull request titles must use: <Feature|Bugfix|Update|Epic> - Description
• Examples:
  • Feature - Add new card variants
  • Bugfix - Resolve search input focus state
  • Update - Improve footer component docs
  • Epic - Refactor component preview architecture

For full examples and guidance, read: How to contribute