Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 990 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 990 Bytes
Raw

Contributing

This projet is open to everyone. Feel free to test the library, share it, improve it, and create merge requests.

Getting started

The library requires Node.js 22+ and yarn.

First, we have to switch to the correct version of node:

nvm use

If you don't have nvm, you may manually install and use Node.js 22+.

Then, we have to use the proper package manager (here yarn):

corepack enable

And install the dependencies:

yarn install

Code

  • The source code is located in the src directory.
  • The projet uses prettier to format the code. You'll want to enable and configure it in your IDE.
  • The tests are run with jest

Commands

  • fb:build: builds the library.
  • fb:format: formats the code using prettier.
  • fb:test: runs the tests using jest.
  • fb:dev: builds the lib in dev mode, and publishes it on a local verdaccio.