CONTRIBUTING.md

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Guidelines

1. Write your patch
2. Add a test case to your patch
3. Make sure that make test runs properly
4. Send your patch as a PR

Setup

1. Fork & clone the repo
2. Install Docker
3. Install docker-compose
4. Run make test from the root directory

How to release bumpversion itself

Execute the following commands:

git checkout master
git pull
make test
make lint
bump2version release
make dist
make upload
bump2version --no-tag patch
git push origin master --tags