From 0adb5164d737d413e696bb18fbc4b6f35f42d3a7 Mon Sep 17 00:00:00 2001 From: Rafa de la Torre Date: Mon, 12 Dec 2016 17:54:02 +0100 Subject: [PATCH] Update README.md Add a bit about versioning stuff --- server/lib/python/cartodb_services/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/server/lib/python/cartodb_services/README.md b/server/lib/python/cartodb_services/README.md index aa3be41..f873544 100644 --- a/server/lib/python/cartodb_services/README.md +++ b/server/lib/python/cartodb_services/README.md @@ -45,3 +45,8 @@ See the [[../../../../test/README.md]]. Basically, move to the `/test` directory cd $(git rev-parse --show-toplevel)/test python run_tests.py --host=$YOUR_HOST $YOUR_USERNAME $YOUR_API_KEY ``` + +## Versioning +Once you're satisfied with your changes, it is time to bump the version number in the `setup.py`. A couple of rules: +- **Backwards compatibility**: in general all changes shall be backwards compatible. Do not remove any code used from the server public `pl/python` functions or you'll run into problems when deploying. +- **Semantic versioning**: we try to stick to [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html)