Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 1.57 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 leximaven can be even better.

Build process & Development Cycle

  • 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

  • lint - fixes stylistic issues in src folder

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

  • 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

I was using Mocha, Chai, and Sinon for testing. At the moment there are no tests.