Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1 KB

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
  1. clone this repo
  2. install dependencies (jest for tests) npm install
  3. create a new branch named [type]-[name] (see example below)
  4. commit your changes
  5. run tests npm run test
  6. push your branch to the remote repository
  7. create a pull request

Run tests

npm run test

img.png


Run encryption from command line

npm run encrypt

img_1.png


Minify

Until I finalize the pipeline, builds are performed manually.

npm run build

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)

img_3.png