From c173215b2968f7ccc145bd3462ef19edf2d92077 Mon Sep 17 00:00:00 2001 From: Josh Creek Date: Fri, 7 Oct 2022 21:32:25 +0100 Subject: [PATCH] docs(*): Add git version example to readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 5abcd68..c77e294 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ To run the project locally with hot reload, use the command `npm run dev`. All linting errors can be automatically fixed (usually) by running `npm run lint -- --fix` before you commit your changes. +This project uses symantic versioning. `Major.Minor.Patch` e.g. 1.1.2 + +When you create your Pull Request, ensure you add the relevant git tag using something like `git tag -a 1.1.0 -m "Add PWA support"` or `git tag -a 1.1.1 -m "Fix input duplication"`, then `git push origin --tags` to push the tag to the repository. + ## Development notes You can access a list of all the assets when debugging by visiting `http://localhost:3000/webpack-dev-server`