Reporting issues

The rsonpath project is under active development. However, we have very limited resources that can be spent on it, so user feedback is crucial to make us aware of issues and decide how to prioritize them.

Bugs

If you find a bug, report it with our bug report form on GitHub.

The most important part of a bug report is an MRE – Minimal Reproducible Example. For rsonpath this is usually the query, and the JSON document that causes the bug. You might not be possible to publish the actual document due to licensing or non-disclosure agreements, but it is often possible to narrow down the issue and publish a small, anonymized example, where keys in the query and the document are replaced with different, meaningless values.

New features/enhancements

If there is a particular feature you really need, or maybe a query that takes too long and we could optimize against, you should create an issue and let us know.

If there is an issue already open related to your problem, comment or upvote that issue to let us know to prioritize that! It’s a small thing, but really helpful.

Security vulnerabilities

Security vulnerabilities follow a separate flow, using GitHub’s private reporting system. Consult Privately reporting a security vulnerability to learn how to open a report.