Skip to content

Contribution Guide

We welcome contributions. Here's how to get started.

How to Contribute

  1. Fork the repository
  2. Create a feature branch: git checkout -b feat/my-feature
  3. Make your changes
  4. Run the build: pnpm build
  5. Commit: git commit -m "feat: add my feature"
  6. Push: git push origin feat/my-feature
  7. Open a Pull Request

Commit Convention

Use Conventional Commits:

PrefixUse
feat:New feature
fix:Bug fix
docs:Documentation change
refactor:Code change that doesn't fix a bug or add a feature
chore:Maintenance tasks

Pull Request Guidelines

  • Keep PRs focused — one feature or fix per PR
  • Include a clear description of what changed and why
  • Make sure the build passes
  • Update documentation if your change affects user-facing behavior

Docs Consistency Checklist

  • Include all 4 package manager tabs
  • Keep tab order consistent
  • Avoid npm-only script references unless intentional

Issues

Found a bug or have a feature request? Open an issue.

Please include:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce
  • Node.js version and OS

Released under the MIT License.