Contributing

Use a separate branch for development with the following naming convention

- bugfix-some-unique-branch-name
- hotfix-some-unique-branch-name
- feature-some-unique-branch-name

clone this repo
install dependencies npm install
create a new branch named [type]-[name] (see example below)
commit your changes
run tests npm run test
push your branch to the remote repository
create a pull request if tests are passing

Please keep the following in mind when developing:

Add tests for modified or additional code
Keep code bloat to a minimum, the final minified code should remain very small
Maintain a consistent style
Use no dependencies
Comment everything (see example)

Run tests

npm run test

Minify

This is only relevant to the repository maintainer.

Until the CI/CD pipeline is finalized, builds are performed manually against the master branch.

increment the version number in package.json
run npm run build
create a new release

npm run build