Contributing

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to honor this code.

Getting started

The best way to start developing this project is to set up a virtualenv and install the requirements.

git clone <my remote url/sodapy.git>
cd sodapy
virtualenv venv
source venv/bin/activate
pip install -r requirements-dev.txt

Install the package, and run tests to confirm that everything is set up properly.

pip install .
pytest

Fork this repository
Create a branch: git checkout -b my_feature
Make changes
Run black sodapy tests to ensure that your changes conform to the coding style of this project
Commit: git commit -am "Great new feature that closes #3". Reference any related issues in the first line of the commit message.
Push: git push origin my_feature
Open a pull request
Pat yourself on the back for making an open source contribution :)

Please review the open issues before opening a PR.
Significant changes or new features should be documented in README.md.
Writing tests is never a bad idea. Make sure all tests are passing before opening a PR.