diff --git a/README.md b/README.md index 8a3af2d0deb563ff21750a3cdb75f207cffa48e0..1eec9f5f4882947b2b5e46aa7000d68cde0c5df4 100644 --- a/README.md +++ b/README.md @@ -31,5 +31,17 @@ To run the unit tests, move to the root folder of the project, and execute: pytest -v ``` +### Using bumpver +For developers: When you want to publish a new version, use +``` bash +# Increment the PATCH version when you make backwards compatible bug fixes. +bumpver update --patch +# Increment the MINOR version when you add functionality in a backwards compatible manner. +bumpver update --minor +# Increment the MAJOR version when you make incompatible API changes. +bumpver update --major +``` +[(Source)](https://semver.org/#summary) + ## References We used this excellent guide for packaging: https://realpython.com/pypi-publish-python-package/ \ No newline at end of file