Skip to content
This repository has been archived by the owner on Jun 2, 2022. It is now read-only.

Latest commit

 

History

History
20 lines (13 loc) · 736 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 736 Bytes
Raw

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

This repository hosts the @ledgerhq/* JavaScript libraries.

JavaScript styleguide

  • ES6+ features.
  • prettier for formatting convention. You can run npm run prettier.
  • ESLint is used to enhance code quality. Check with yarn run lint.
  • TypeScript is used to typecheck the library. Check with yarn build.

NB. for the 3 points above, the best is to have integration of Prettier, ESlint, Flowtype in your text editor (there are plugin for most editors).

Documentation

  • documentation.js for generation markdown documentations of libraries. You can run yarn doc.