Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 1.27 KB
Raw

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

As a lerna mono repository the code is split up in multiple packages:

  • packages/get-changelog-cli for the CLI tool
  • packages/get-changelog-lib for the library part (used by the CLI and for other packages)

All the devDependencies are hoisted in the root directory for easier maintenance. Test files are marked by the .test suffix and are located near the files they correspond to.

Set up

$ git clone https://github.com/Clement134/get-changelog.git && cd get-changelog
$ npm ci
$ npx lerna bootstrap

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

Unit tests

Unit tests are written with Jest. Tests can be started from the root folder.

$ npm test

Local testing

$ npm link
$ get-changelog