Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

46 lines (27 loc) · 1.4 KB

Contribution guide

Developing mapbox-gl-draw-rectangle-restrict-area

You consider contributing changes to mapbox-gl-draw-rectangle-restrict-area – thank you! Please consider these guidelines when filing a pull request:

How to make changes

  1. Clone the repository

    $ git clone https://github.com/dqunbp/mapbox-gl-draw-rectangle-restrict-area.git
    
  2. Install the dependencies

     $ cd mapbox-gl-draw-rectangle-restrict-area
     $ npm install
    
  3. Make your changes

  4. Add changes to tracked git files

     $ git add .
    
  5. Run commitizen

     $ npm run commit
    

    and follow the command prompt. To provide multiline long description use \n, for example:

    - add repo link to the docs\n- update example\n - etc.

Creating releases

mapbox-gl-draw-rectangle-restrict-area uses semantic-release to release new versions automatically.

  • Commits of type fix will trigger bugfix releases, think 0.0.1
  • Commits of type feat will trigger feature releases, think 0.1.0
  • Commits with BREAKING CHANGE in body or footer will trigger breaking releases, think 1.0.0

All other commit types will trigger no new release.