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

  1. Fork the Cocktail-Shaker repository on GitHub, then clone the fork to your local machine:

    git clone https://github.com/<username>/Cocktail-Shaker.git
    
  2. Install the development requirements:

    cd Cocktail-Shaker
    pip install -r requirements/development.txt
    
  3. Create a new branch for your changes:

    git checkout -b <name-for-changes>
    
  4. Make your changes or additions. Ideally create some tests and ensure they pass.

  5. Commit your changes and push to your fork on GitHub:

    git add .
    git commit -m "<description-of-changes>"
    git push origin <name-for-changes>
    
  1. Submit a pull request.

Tips