Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (35 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

62 lines (35 loc) · 1.25 KB

Before You Post!

Support

You can either open a Github issues or contact me through CodeMentor if you need an fast answer.

Development

Setup

  1. Install Node.js

  2. Fork the project and clone your fork - guide

  3. Install local dependencies

npm install

Developing

  1. Compile changes

    npm run compile

  2. Run tests

    npm test

Publishing

Follow these steps in order to implement your changes/improvements into your desired project:

Preparation

  1. Make sure your changes are on their own branch that is branched off from master.

  2. You can do this by: git checkout master; git checkout -b your-new-branch

  3. And push the changes up by: git push origin your-new-branch

  4. Ensure all tests pass:

npm test

If possible, add tests for your change, if you don't know how, mention this in your pull request

Pull Request

To send your changes for the project owner to merge in:

  1. Submit your pull request
  2. By submitting a pull request you agree for your changes to have the same license as the original plugin