CONTRIBUTING.md

Contribution guidelines

1. You may want to check TODOs on open issues (not assigned).

2. Create a new branch with the name of your proposal:

   • If you're already a collaborator, prefer to create a fix/*, feat/* or docs/* branch on official repository;
   • If you're not a collaborator yet, fork the repository and create the branch;

3. Clone and setup the monorepo:

git clone [email protected]:{user}/storefront.git
cd storefront
npm i

4. Edit source files and test changes locally:

   • npm run serve to serve the entire template;
   • npx lerna run --scope=@ecomplus/{pkg} serve to call specific tests for some widget or UI package;
   • You may also want to edit test files at @ecomplus/{pkg}/__tests__/ folder;
   • Documentation should be at @ecomplus/{pkg}/docs/ folder and you can test it running Vuepress with npm run docs:dev;

5. Commit following Conventional Commits;

6. Ensure you're respecting JavaScript Standard Style and Vue Style Guide;

7. Open a new PR to master (latest version) or v*-dev branch;

8. Congrats! Just wait a little for our review and merge.

Thanks in advance 😄