Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1010 Bytes

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 1010 Bytes

Contributing

Fork & clone the repository

git clone [email protected]:<your-username>/img2zpl.git
cd img2zpl
git remote add upstream [email protected]:mtking2/img2zpl.git
bin/setup

Then check out a working branch:

git checkout -b <my-working-branch>

Write tests

This project uses rspec. After writing your tests, you can run tests with the following command:

bundle exec rspec

Write code

Write your code to make your tests pass.

Update the CHANGELOG with a description and your name

Update the CHANGELOG with the description of your code changes and your name on the line after "* Your contribution here".

Commit and push your changes

Commit and push your changes to your working branch.

git commit -am 'Add some feature'
git push origin <my-working-branch>

Open a pull request

Open a pull request against upstream master and your working branch. Give a brief description of what your PR does and explain what the code changes do.

Thank you!