Skip to content

Latest commit

 

History

History
executable file
·
36 lines (26 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
36 lines (26 loc) · 2.14 KB

Contributing

As of right now, I am the only one contributing to this project. I welcome you to open issues and submit pull requests so that iloa can be even better.

Build process

  • Mocha is the test harness and Chai is assertions

  • Test style is BDD

  • Build is managed with npm scripts. redrun is my task runner. Here are the tasks:

  • bin - transpiles src into bin

  • bump - after release task, pushes version to repo and publishes npm package

  • clean - deletes all generated files

  • climate - CI-only task to submit test coverage

  • cover - instruments code, calculates coverage, generates lcov and cleans up

  • lcov - generates lcov.info from nyc data

  • lint - fixes stylistic issues in src folder

  • test - compiles test file, uses test runner

  • release - uses standard-version to update the CHANGELOG and modify the version in package.json

  • report - generates a nice HTML test report to load in your browser

  • watch - watches src directory for changes and automatically compiles to bin folder

Changelog & Versioning

Coding Style & Linting

This project adheres to standard formatting rules.

Testing

Mocha is the test runner and it uses Chai for assertions. Tests are written in BDD style. Coverage is calculated with nyc and babel-plugin-istanbul.