Contributing to JSONata
A good first start would be to ask a question here, or see previous questions tagged with
There are a community of users in the JSONata Slack workspace who can help with queries. You can request an invite by going to the JSONata exerciser and clicking the Slack icon in the top-right.
For bugs, suspected bugs and any other odd behaviour, please open a GitHub issue. Preferably include a link to the JSONata exerciser which includes your source data and expression. This can be done using the "Share" function in the top-right.
For any enhacement request, please open a GitHub issue
Cloning and building
To contribute changes to the JSONata code (or documentation), fork the
jsonata repository, clone the fork and make your changes. You can then contribute back to the main project by opening a pull request, ensuring you have maintained code coverage.
JSONata conformance test suite
This section is incomplete
The tests use the
mocha framework and can be executed by running
npm t or
npm run test which also runs
eslint linting to check the code meets the formatting requirements of the project.
Documentation, such as this, is all part of the
jsonata main GitHub project. It is written in Markdown, and updates (improvements, fix, etc.) are welcome via pull requests.