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 packages/react-querybuilder/src/types.
• 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 example (JS version), or any of the other examples as a template.

Generated files

Some files committed to this repo are generated by scripts and should not be modified by hand.

• The CEL and SQL parsers. Edit cel.jison or sql.jison as appropriate, then run bun generate-parsers to refresh the following files:
  • celParser.js
  • sqlParser.js
• Certain examples. Edit ./examples/_template, then run bun generate-examples to refresh the following folders:
  • examples/antd
  • examples/basic-ts
  • examples/basic
  • examples/bootstrap
  • examples/bulma
  • examples/chakra
  • examples/fluent
  • examples/mantine
  • examples/dnd
  • examples/material

If any of the source files are modified, please refresh the respective generated file(s) before committing your changes.