Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

65 lines (43 loc) · 1.74 KB

Contributing to JSON P3

Hi. Your contributions and questions are always welcome. Feel free to ask questions, report bugs or request features on the issue tracker or on Github Discussions.

Table of contents

Development

The JSONPath Compliance Test Suite is included as a git submodule. Clone the JSON P3 git repository and initialize the CTS submodule.

$ git clone [email protected]:jg-rp/json-p3.git
$ cd json-p3
$ git submodule update --init

We use npm to mange packages and run scripts during development. Install development dependencies with:

$ npm install --production=false

And run tests with the test script.

$ npm test

Check for linting errors with the lint script.

$ npm run lint

And check for typing errors with the type-check script.

$ npm run type-check

Generate an HTML test coverage report with the coverage script.

$ npm run coverage

Then open coverage/index.html in your browser.

Build distribution bundles and generate .ts files with the build script. This will write bundles to the dist/ folder.

$ npm run build

Documentation

Documentation is built with Docusaurus. Find its source in the docs/ folder of the main branch. Start the Docusaurus development server from within the docs/ folder.

$ cd docs
$ npm run start