Skip to content

Commit

Permalink
Add documentation about contributing / versioning
Browse files Browse the repository at this point in the history
Previously it was unclear when to use the in-built versioning system.
  • Loading branch information
Ben Thorner committed Jan 2, 2020
1 parent 1bcebd4 commit 266113f
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CONTRIBUTING

Contributions welcome - just raise a PR and make sure the tests pass!

## Versioning

GOV.UK Docker is [versioned][version] in order to notify users about important changes, where they may need to take action. Since we use the repo itself for distributing GOV.UK Docker, for many PRs it's unlikely you will need to change the version.

> A consequence of this is that GOV.UK Docker does *not* (need to) follow [semantic versioning][semver].
Any change to the [version][] should be accompanied with an explanation in the [CHANGELOG][]. When the [version][] changes, a user running the `govuk-docker` CLI will see a one-time notification, which includes the new [CHANGELOG][] entry.

[version]: exe/govuk-docker-version
[CHANGELOG]: CHANGELOG.md
[semver]: https://semver.org/

0 comments on commit 266113f

Please sign in to comment.