👍🎉 First off, thanks for taking the time to contribute! 🎉👍
This repository hosts the Ledger Live Platform SDK.
- ES6+ features.
- prettier for formatting convention. Check
yarn format:check. - ESLint is used to enhance code quality. Check with
yarn lint:check. - 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 is paramount for any project, especially a public and open sourced one.
To document this project, we use the popular diataxis documentation framework.
The documentation content, either generated or manually added, can be found under the docs folder.
We use typedoc to generate our reference documentation, located under docs/reference, don't forget to add appropriate comments to your code.