- Follow PEP8 standards.
- Name variables with underscores and lowercase letters. Not camelCase.
- Limit the first line to 72 characters or less
- Reference issues and pull requests
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:
when improving the format/structure of the code - 🐎
:racehorse:
when improving performance - 📜
:scroll:
when writing docs - 🐧
:penguin:
when fixing something on Linux - 🍎
:apple:
when fixing something on Mac OS - 🏁
:checkered_flag:
when fixing something on Windows - 🐛
:bug:
when fixing a bug - 🔥
:fire:
when removing code or files - 💚
:green_heart:
when fixing the CI build - ✅
:white_check_mark:
when adding tests - 🔒
:lock:
when dealing with security - ⬆️
:arrow_up:
when upgrading dependencies - ⬇️
:arrow_down:
when downgrading dependencies - 🔧
:wrench:
when doing CI
- 🎨
-
Make your changes in a new git branch:
git checkout -b fix-branch master
-
Create your patch, including appropriate test cases.
-
Commit your changes using a descriptive commit message as mentioned above
git commit -a
-
Build your changes locally to ensure all the tests pass:
nosetests
-
Push your branch to GitHub:
git push origin my-fix-branch
-
In GitHub, send a pull request to
ImageScraper:master
.
Thank you for your contribution!