@contentmunch/muncher

Content editor wysiwyg for contentmunch

Usage no npm install needed!

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

README

Test release and publish

Muncher

Muncher is a rich text editor based on Draftjs with a focus on content reuse.

Using Muncher

To use this component library:

  • add the npm package to your project
    $ npm install @contentmunch/muncher

Installation guide

In the project directory, you can run:

npm start

Launches the component explorer on port 6009

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