Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 773 Bytes

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 773 Bytes
Raw

Contribution quick guide

Clone the repo

git clone git@github.com:pandomic/serverless-offline-variables.git

Install dependencies

npm install

or

yarn install

Do your changes

  1. Keep things stupid simple
  2. Try to keep the code clean, nice and readable
  3. Test the core functionality
  4. Once you are done, please check the code using
npm run lint
npm run test

Commit your changes

We use the next format for commit headers:

<type>(<scope>): <Short description>

where type could be:

  • chore - regular changes
  • feat - new features
  • fix - fixes

For example:

chore(docs): Update documentation

Open PR

Once you are done with everything, feel free to propose your changes by opening a new PR.