Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 1.38 KB

Contributing

Thank you for considering contributing to this library! Below you can find the instructions on the development process, as well as testing and publishing guidelines. Don't hesitate to reach out to the library maintainers in the case of questions.

Pre-requisites

Git workflow

$ git checkout -b <FEATURE>
$ git add .
$ git commit -m 'Adds contribution guidelines'
$ git push -u origin <FEATURE>

Ensure that your feature branch is up-to-date with the latest main before assigning it for code review:

$ git checkout master
$ git pull --rebase
$ git checkout <FEATURE>
$ git rebase master

Once your changes are ready, open a Pull request and assign one of the library maintainers as a reviewer. We will go through your changes and ensure they land in the next release.

Develop

$ yarn start

Test

Run all tests

$ yarn test

Run a single test

$ yarn test test/add.test.ts

Publish

Follow this instructions to publish the library:

  1. Log in with your NPM account (verify your current user with npm whoami).
  2. Run yarn publish.
  3. Set the next version of the library.
  4. Wait for the build to succeed.
  5. Push the release commit and tag with git push --follow-tags.