LogoUsefulKey
Additional info

Contributing

How to contribute to UsefulKey

Quick Start

  1. Fork the repo on GitHub
  2. Clone your fork locally
  3. Install dependencies: pnpm install
  4. Create a feature branch for your changes
  5. Make your changes and test them
  6. Submit a pull request

What We Expect

For Code Changes

  • Follow the existing code style
  • Add tests for new features or bug fixes
  • Update documentation if needed
  • Keep changes focused and small when possible

For Bug Reports

  • Use our bug report template
  • Include steps to reproduce
  • Share your environment (OS, Node version, etc.)

For Feature Requests

  • Start with a GitHub issue to discuss the idea
  • Explain the use case and why it would be valuable

Development Setup

# Install dependencies
pnpm install

# Run tests
pnpm test:all

# Build the project
pnpm build

# Run examples
cd examples/[example-name] && pnpm dev

#Run lint 
pnpm biome

Questions?

Feel free to open a GitHub issue if you need help or have questions. Feedback is welcome!