CONTRIBUTING.md

Contribution to the project is more than welcome! 🍺

Bug submission

If you're submitting a bug, please clearly state what is:

1. the JSON Schema content that fails: go to the demo page, paste your schema, click generate and grab the updated URL from browser address bar - and paste it here. It will make it easier for us to fix it, thanks in advance 🍺 Otherwise please paste the schema inline.
2. the result you get
3. the result you expected

Issues & Pull-requests

• When submitting bugs (or inappropriate behavior), do paste your schema example if only it's possible. This will prevent us from explicitly asking you to do this.
• When submitting PRs, ship them under the develop branch.
• The testing approach architecture is described in spec/README.md.
• PR without specs will not be merged soon.

Releasing new versions

• Include a new entry in CHANGELOG.md file,
• Be followed by re-building and re-releasing online demo, see website-jsf gh-pages branch.

Development tasks

• npm run dev — Run the tests and watch (preferred during development)
• npm run dev:lint — Run eslint on all sources
• npm run dev:unit — Run jasmine-node on unit tests
• npm run dev:schema — Run jasmine-node on schema tests
• npm run cover — Run istanbul + jasmine-node
• npm run cover:up — Upload to coveralls (CI only)
• npm run dist — Prepare all assets with locales for CDN support
• npm test — Run all the tests

Upcoming

• npm run tsc — Compile TypeScript to JavaScript (via commonJS)