Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (29 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

51 lines (29 loc) · 1.2 KB

Setup

  1. Install Node.js

  2. Fork the project and clone your fork - guide

  3. Install local dependencies

npm install

Developing

  1. Make your changes to the project

  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. When submitting, if the original project has a dev or integrate branch, use that as the target branch for your pull request instead of the default master
  3. By submitting a pull request you agree for your changes to have the same license as the original plugin