Skip to content

Latest commit

 

History

History
35 lines (30 loc) · 919 Bytes

contributing.md

File metadata and controls

35 lines (30 loc) · 919 Bytes

Contributing Guide

  • Contributing to this project is fairly easy. This document shows you how to get started

Submitting changes

  • Fork the repo
  • Check out a new branch and name it to what you intend to do:
    • Example:
      $ git checkout -b BRANCH_NAME
      
      If you get an error, you may need to fetch develop first by using
      $ git remote update && git fetch
      
    • Use one branch per fix / feature
  • Commit your changes
    • Please provide a git message that explains what you've done
    • Commit to the forked repository
    • Example:
      $ git commit -am 'Added some nice feature'
      
  • Push to the branch
    • Example:
      $ git push origin BRANCH_NAME
      
  • Make a pull request
    • Make sure you send the PR to the develop branch

If you follow these instructions, your PR will land pretty safely in the main repo!