Skip to content

Latest commit

 

History

History
42 lines (37 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

42 lines (37 loc) · 2.31 KB

Contributing

  • All PRs are welcome in the develop branch.
  • Please, stick to the defined Purpose of the repo and try to write your code as readable as possible.
  • Yarn Workspaces + Lerna are used in this monorepo.
  • We do code reviews and may ask you to change things before we merge code.
  • Note that gitmoji is used in the commit messages. That's not a must but we think it's nice.

Useful commands

  • $ yarn lint - As run in your pre-commit
  • $ yarn test - As run in your pre-push
  • $ ./node_modules/.bin/lerna run build builds all the packages in their respective dist folders.
  • $ ./node_modules/.bin/lerna run test --scope=@signpdf/signpdf -- --watch --coverage runs tests in a specified package tracking coverage and watching.
  • $ yarn workspace @signpdf/signpdf add node-forge -D adds a node-forge as a dev dependency of @signpdf/signpdf
  • $ yarn workspace @signpdf/signpdf add @signpdf/some-new-subpackage@* -D adds a @signpdf/some-new-subpackage as a dev dependency of @signpdf/signpdf. Note the @* version specifier.
  • $ npm publish --access public is needed the first time a package get published as our packages are scoped and that is private by default. See: https://bit.ly/47ScKPF

Contributors