Skip to content

Commit eed7501

Browse files
committed
DOC: Add info about semver and conventional commits
1 parent 217261b commit eed7501

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/source/updating_services.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ Instructions
4141
4242
git checkout -b my-new-feature
4343
44-
5. Add and make changes to your app's code as needed, committing each self-contained change
44+
5. Add and make changes to your app's code as needed, committing each self-contained change. Use the `Conventional
45+
Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_ commit message format so the new version for your service
46+
can be automatically calculated.
4547

4648
.. code-block:: shell
4749
@@ -61,7 +63,9 @@ Instructions
6163

6264
.. image:: images/updating_services/pytest.png
6365

64-
8. Update the semantic version of your app:
66+
8. Update the `semantic version <https://semver.org/>`_ of your app. This communicates to anyone updating from a
67+
previous version of the service whether they can use it as before or if there might be changes they need to make to
68+
their own code or data first.
6569

6670
- ``poetry version patch`` for a bug fix or small non-code change
6771
- ``poetry version minor`` for a new feature

0 commit comments

Comments
 (0)