Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (22 loc) · 841 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 841 Bytes

Contributing

Thanks for taking the time to contribute to this project!

How to help?

There are multiple tasks you can do in order to help us, for example:

  • fill an issue to report bugs or your specific needs
  • contribute to existing issue
  • write a PR to improve the project

Repository structure

All the important files are in the src directory.

Set up

$ git clone https://github.com/BetaHuhn/ackee-report && cd ackee-report
$ npm install

Commands

Linting

ESlint is used for linting. It's recommended to add the corresponding extension to your editor. It's also possible to run the lint task with the following command:

$ npm run lint

Local testing

Run npm link to install the library locally and make the command ackee-report available to your user.