Skip to content

Commit

Permalink
πŸ“ Help contributors aroud lerna and yarn workspaces
Browse files Browse the repository at this point in the history
  • Loading branch information
vbuch committed Oct 6, 2023
1 parent e5a2673 commit 297b367
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
# Contributing

* All PRs are welcome in the `develop` branch.
* Please, stick to the repo's defined [Purpose](https://github.com/vbuch/node-signpdf#purpose) and try to write your code as readable as possible.
* **All PRs are welcome** in the `develop` branch.
* Please, stick to the defined [Purpose](https://github.com/vbuch/node-signpdf#purpose) of the repo and try to write your code as readable as possible.
* [Yarn Workspaces](https://classic.yarnpkg.com/lang/en/docs/workspaces/) + [Lerna](https://lerna.js.org/) are used in this **monorepo**.
* We do code reviews and may ask you to change things before we merge code.
* Note that [gitmoji](https://gitmoji.carloscuesta.me/) 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.

## Contributors

* [vbuch](https://github.com/vbuch)
Expand Down

0 comments on commit 297b367

Please sign in to comment.