Contributing¶
Contributing¶
Contributions of any kind to cocktail-shaker are greatly appreciated! All contributions are welcome, no matter how big or small.
If you are able to contribute changes yourself, just fork the source code on GitHub, make changes, and file a pull request.
Quick Guide to Contributing¶
Fork the Cocktail-Shaker repository on GitHub, then clone the fork to your local machine:
git clone https://github.com/<username>/Cocktail-Shaker.git
Install the development requirements:
cd Cocktail-Shaker pip install -r requirements/development.txt
Create a new branch for your changes:
git checkout -b <name-for-changes>
Make your changes or additions. Ideally create some tests and ensure they pass.
Commit your changes and push to your fork on GitHub:
git add . git commit -m "<description-of-changes>" git push origin <name-for-changes>
Tips¶
Follow the PEP8 style guide.
Include docstrings as described in PEP257.
Try and include tests that cover your changes.
Try to write good commit messages.
Consider squashing your commits with rebase.
Read the GitHub help page on Using pull requests.