Contributing Guide

The best contributions are focused, easy to review, and clear about the user problem they solve.

You can help by:

• Fixing bugs.
• Improving docs.
• Adding new UI components.
• Adding examples.
• Improving accessibility.

Open an issue before starting a large change so maintainers can confirm the problem and scope. Small fixes, documentation edits, and example improvements can usually go straight to a pull request.

Good first changes include:

• Fixing unclear docs.
• Adding a missing example state.
• Improving labels or keyboard behavior.
• Cleaning up a component prop or class name.
• Fixing a bug with a small reproduction.

1. Fork the repo and clone it.
2. Create a new branch.
3. Make a small, focused change.
4. Run the checks that apply to the changed files.
5. Open a pull request with a clear description.

npm run lint -- path/to/changed-file.tsx
npm run build
npm run build:package
npm --prefix package/honestui run typecheck

If you changed docs, check that the docs site still builds and the changed pages render correctly.

Please include:

• What changed.
• Why you changed it.
• Screenshots if UI changed.
• Any breaking changes.
• The checks you ran.

Keep unrelated changes in separate pull requests so each change can be reviewed and verified on its own.

When adding or changing a component, check:

• The default example is useful.
• Important states are documented.
• The component works with keyboard navigation.
• Labels, descriptions, and errors are connected where needed.
• The manual installation block lists required dependencies and CSS variables.
• The component source and examples use the same import style as the rest of the registry.

When changing docs, use simple language.

Prefer short paragraphs and specific examples. Explain when to use a component, when not to use it, and what each example demonstrates.

For the full technical process, file conventions, and registry details, see:

Full CONTRIBUTING.md