From 6fe8ac4e000969d693f88122bd332c9b59c456f5 Mon Sep 17 00:00:00 2001
From: Ross <43380330+Ross-Clark@users.noreply.github.com>
Date: Wed, 11 Dec 2019 16:00:19 +0000
Subject: [PATCH] Update README.md (#96)

* Update README.md

add notes on release and problems on windows
---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index bce8f96..daa9707 100644
--- a/README.md
+++ b/README.md
@@ -160,3 +160,21 @@ npm run test:integration
 ```
 
 N.B. The integration tests rely on there being a test server available on localhost:8080.
+
+## Contributing to a release.
+
+A new Tag must be made for the release following the versioning format.
+We use Semantic Versioning.
+IE. x.y.z where:
+x = Major version that causes incompatibilities,
+y = Minor change that adds a backwards comptible feature,
+z = Patch version for backwards compatible fixes.
+more information can be found at https://semver.org/
+
+The release also must contain changes to the package version number to match the new tag.
+
+If the release contains a change that will require the banner to be redisplayed to users, then the `COOKIE_VERSION` variable in cookieconsent.js must be increased by 1.
+
+## Notes
+Currently, in-house development for this solution is primarily done on UNIX systems.
+There may be some difficulties when developing this solution on a windows machine.