Below you can find our opinionated guide on how to contribute to this repository, and how we prefer to work at Pinelab.
- Create a fork of this repository
- Checkout the
main
branch and make sure it's up to date withgit pull upstream main
- Create a feature branch
git checkout -b feat/example-feature
yarn
in the root of the project.cd packages/vendure-plugin-example
andyarn
again to install it's dependencies- Commit using the commandline, so that the eslint autocheck is executed
git commit -a -m 'feat(feat/example-plugin): implemented example stuff'
- Don't forget to manually increase the version number to the next patch/minor/major, so that the package will get published.
yarn lint:check
to check if all files are formatted and linted correctly.yarn lint:fix
Fix formatting and linting IN ALL PACKAGES. To just run in the package you've been working in use:yarn lint --fix ./packages/test