Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 1.27 KB

Contributing

Check open issues for things that need work.
Also check any open pull requests to make sure any changes you want to make haven't already been made by someone else.

Fork & clone the repository

git clone [email protected]:<your-username>/py-zebra-zpl.git
cd py-zebra-zpl
git remote add upstream [email protected]:mtking2/py-zebra-zpl.git
python setup.py develop

Then check out a working branch:

git checkout -b <my-working-branch>

Write tests

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

pytest -v

Write code

Write your code to make your tests pass.

Update the CHANGELOG with a description and your name

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

Commit & 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!