Skip to main content
Module

x/react_querybuilder/CONTRIBUTING.md

A QueryBuilder component for React
react-querybuilder/react-querybuilder
Go to Latest
File

Contributing

Contributions to react-querybuilder and other associated packages are more than welcome. When preparing to submit a pull request, please first discuss the change you wish to make by creating a new issue or discussion topic.

  • If adding a new feature, be sure to add corresponding tests since we maintain 100% coverage.
  • If changing behavior or adding a feature, make sure the documentation is updated. You may need to update both the current (aka “next”) docs and the latest versioned docs.
  • If applicable, update the TypeScript definitions in the @react-querybuilder/ts package.
  • If your editor doesn’t automatically format code with Prettier when saving changes, run bun pretty-print (requires Bun) before committing.
  • When addressing a bug, please provide a reproducible example (we typically use CodeSandbox, but any interactive demo or example repo is fine). Feel free to use our CI base, the basic template (JS version), or any of the other examples as a starting point.