contributing.md

Contributing

Development server

When developing, run the following from the root-level directory:

npm install
npm run build
npm start

All packages will be live-built, and a live development server showcasing components with hot reload enabled will then run at localhost:8080.

Coding style

All the JavaScript code in this project conforms to the prettier coding style. Code is automatically prettified upon commit using precommit hooks.

Documentation

We use mkdocs to build our documentation. To run documentation locally, run:

pip install -r requirements.docs.txt
mkdocs serve

Documentation will be served on localhost:8000.

Tests

npm test

Code coverage

Code coverage reports are currently available only for the @rjsf/core package. They are generated using nyc each time the npm test-coverage script is run. The full report can be seen by opening ./coverage/lcov-report/index.html.

Releasing

To release, run:

lerna version
lerna run build
lerna publish from-git

Make sure you use semver for version numbering. Once a new version has been released, create a release in the Github "Releases" tab and add the version history.

Releasing docs

Docs are automatically released using Read The Docs based on the latest commits from the master branch.

Releasing the playground

In order to publish the latest playground to https://rjsf-team.github.io/react-jsonschema-form/ after a new rjsf release, run:

cd packages/playground
npm run publish-to-gh-pages