Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

19 lines (14 loc) · 1.13 KB

Contributing to the Pinelab plugins

Below you can find our opinionated guide on how to contribute to this repository, and how we prefer to work at Pinelab.

Gettings started

  1. Create a fork of this repository
  2. Checkout the main branch and make sure it's up to date with git pull upstream main
  3. Create a feature branch git checkout -b feat/example-feature
  4. yarn in the root of the project.
  5. cd packages/vendure-plugin-example and yarn again to install it's dependencies
  6. Commit using the commandline, so that the eslint autocheck is executed git commit -a -m 'feat(feat/example-plugin): implemented example stuff'
  7. Don't forget to manually increase the version number to the next patch/minor/major, so that the package will get published.

Helpfull commands

  • 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