Skip to content

Commit 6fe8ac4

Browse files
Ross-Clarkbradmorton1
authored andcommitted
Update README.md (#96)
* Update README.md add notes on release and problems on windows
1 parent 6cca16e commit 6fe8ac4

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,3 +160,21 @@ npm run test:integration
160160
```
161161

162162
N.B. The integration tests rely on there being a test server available on localhost:8080.
163+
164+
## Contributing to a release.
165+
166+
A new Tag must be made for the release following the versioning format.
167+
We use Semantic Versioning.
168+
IE. x.y.z where:
169+
x = Major version that causes incompatibilities,
170+
y = Minor change that adds a backwards comptible feature,
171+
z = Patch version for backwards compatible fixes.
172+
more information can be found at https://semver.org/
173+
174+
The release also must contain changes to the package version number to match the new tag.
175+
176+
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.
177+
178+
## Notes
179+
Currently, in-house development for this solution is primarily done on UNIX systems.
180+
There may be some difficulties when developing this solution on a windows machine.

0 commit comments

Comments
 (0)