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 ipyvizzu-story with Python virtual env.

Run the dev make target to set up your environment.

make dev

Note: The dev make target is going to set up pre-commit and pre-push hooks into your local git repository. Pre-commit hook is going to format the code with black and pre-push hook is going to run the CI steps.

Run the clean make target to clear your environment.

make clean

CI

The CI steps check code formatting, run code analyses, check typing and run unit tests over the ipyvizzu-story project.

The check make target collects the above tasks. Run the check make target to run the CI steps.

make check

Formatting

The ipyvizzu-story project is formatted with black.

Run the format make target to format your code.

make format

Run the check-format target to check code formatting.

make check-format

Code analyses

The ipyvizzu-story project is analysed with pylint.

Run the check-lint make target to run code analyses.

make check-lint

Typing

The ipyvizzu-story project is using type hints.

Run the check-typing make target to run check code typing.

make check-typing

Testing

The ipyvizzu-story project is tested with unittest testing framework.

Run the test make target to install ipyvizzu-story into your virtual environment and run the tests.

make test

Documentation

Run the doc make target to build the documentation.

Note: If you modify the documentation, you also need to configure the JavaScript development environment.

make dev-js

make check-js

make doc

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

Release

ipyvizzu-story is distributed on pypi. Note: You need to be an administrator to release the project.

If you want to release ipyvizzu-story follow the steps below.

  • You should increase the version number in setup.py. 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, checks and uploads the ipyvizzu-story package to pypi.

You can build and check the package before a release with the release make target.

make release