Skip to content

Contributing

Issues

You can find our open issues in the project's issue tracker. Please let us know if you find any issues or have any feature requests there.

Contributing

If you want to contribute to the project, your help is very welcome. Just fork the project, make your changes and send us a pull request. You can find the detailed description of how to do this in Github's guide to contributing to projects.

CI-CD

Development environment

You can initialize the development environment of Vizzu-Story with npm.

Run npm install or npm update --dev command to set up your environment.

npm install  # npm update --dev

Note: You can set up git hooks into your local git repository with the prepare script. Pre-commit hook is going to format the code with prettier and pre-push hook is going to run the CI steps.

npm run prepare

CI

The CI steps check code formatting, run code analyses and run unit tests over the Vizzu-Story project.

The check script runs the above tasks.

npm run check

Formatting

The Vizzu-Story project is formatted with prettier.

Run the prettier script to format your code.

npm run prettier

Run the check-prettier script to check code formatting.

npm run check-prettier

Code analyses

The Vizzu-Story project is analysed with eslint.

Run the check-eslint script to run code analyses.

npm run check-eslint

Run the eslint script to solve the fixable problems.

npm run eslint

Testing

The Vizzu-Story project is tested with jest testing framework.

Run the test script to run the tests.

npm test

Documentation

Run the doc make target to build the documentation.

make dev

make check

make doc

Online version can be read at vizzu-story.vizzuhq.com.

Release

Vizzu-Story is distributed on npm. Note: You need to be an administrator to release the project.

If you want to release Vizzu-Story follow the steps below.

  • You should increase the version number in package.json. The version bump should be in a separated commit.
  • Generate the release notes and publish the new release on Releases.

Note: Publishing a new release will automatically trigger the release workflow which builds and uploads the Vizzu-Story package to npm.

You can build the package before a release with the build script.

npm run build