Skip to content

Commit

Permalink
Update README.md (#96)
Browse files Browse the repository at this point in the history
* Update README.md

add notes on release and problems on windows
  • Loading branch information
Ross-Clark authored and bradmorton1 committed Dec 11, 2019
1 parent 6cca16e commit 6fe8ac4
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 6fe8ac4

Please sign in to comment.