This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code. [code-of-conduct]: http://todogroup.org/opencodeofconduct/#sodapy/[email protected]
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_sodapy
source venv_sodapy/bin/activate
pip install -r requirements.txt
Run tests to confirm that everything is set up properly.
./runtests tests/
- Fork this repository.
- Create a branch
git checkout -b my_feature. - Commit your changes
git commit -am "Great new feature that closes #3". Reference any related issues in the first line of the commit message. - Push to remote
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.