Skip to content

Commit

Permalink
Merge pull request #291 from alphagov/add-contributing-doc
Browse files Browse the repository at this point in the history
Add documentation about contributing / versioning
  • Loading branch information
benthorner authored Jan 2, 2020
2 parents c0cbb6f + 266113f commit 78e44a2
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 78e44a2

Please sign in to comment.