Skip to main content
Version: 3.0.0

Development & Contributing

Be sure to read the Code of Conduct

Setup​

First of all clone the git repository :)

$ git clone https://github.com/axelrindle/github-version-checker.git

and then install the dependencies

$ npm ci

By running npm ci instead of npm i it is ensured that the dependency tree is installed exactly as stated in the package-lock.json file. That guarantees the usage of identical dependency trees throughout development.

Working on the packages​

  1. Bootstrap the Lerna environment
$ npx lerna bootstrap
  1. Do your changes on a seperate branch, e.g. feature/my-bug-fix

Contributing to the documentation​

All documentation resided within the docs/ directory. Is is built upon Docusaurus and primarily written in Markdown.

Install dependencies using

$ npm ci

and start the development server by running

$ npm start

To produce a production build, run

$ npm run build

That produces a static site which can be served using

$ npm run serve