@contentmunch/muncher-viz

Muncher visualization components

Usage no npm install needed!

<script type="module">
  import contentmunchMuncherViz from 'https://cdn.skypack.dev/@contentmunch/muncher-viz';
</script>

README

Test release and publish

Muncher-Viz

A html5 svg and scss based visualization component library

Using Muncher-Viz

To use this component library:

  • Add the npm package to your project
    $ npm install @contentmunch/muncher-viz

Installation guide

In the project directory, you can run:

npm start

Launches the component explorer on port 6010

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the package library.

Coding rules

We use GitHub Flow for our project workflow. To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • Create pull request against develop to merge your code.
  • All features or bug fixes must be tested by one or more [specs][unit-testing].

Pull request format

<subject>

* changes 1
* changes 2

fixes/closes #<github issue number>

Git commit format

<type>: <subject>
<BLANK LINE> 
<body> optional
  • Any line of the commit message cannot be longer 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
  • The subject contains succinct description of the change:
    • use the imperative, present tense: "change" not "changed" nor "changes"
    • no dot (.) at the end
  • Commit type:
    • feat: a new feature
    • fix: a bug fix
    • refactor: a code change that neither fixes a bug nor adds a feature
    • test: adding missing tests
    • chore: changes to the build process or auxiliary tools and libraries such as documentation generation