Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 1.01 KB
Raw

Contribution guidelines

  1. 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;

  2. Clone and setup the repository:

git clone [email protected]:{user}/utils.git
cd utils
npm i
  1. Run dev server and use global ecomUtils or edit test/demo.js for tests on http://localhost:9314/:
npm run serve

  1. Commit following Conventional Commits;

  2. Ensure you're respecting JavaScript Standard Style;

  3. We're using jsdoc, when creating or updating a method, please try to make it well documented if possible;

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

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

Thanks in advance 😄