From 2025d480660f444af6b5af25bae8b6348e71bff8 Mon Sep 17 00:00:00 2001 From: Hanna Laakso Date: Wed, 17 Jan 2018 17:52:22 +0000 Subject: [PATCH] Update Contributing and Changelog --- CHANGELOG.md | 4 ++++ CONTRIBUTING.md | 16 ++++++++++++++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 346f508e42..370d6bf7b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,9 +38,13 @@ Fixes: previously relied on the global link styles. (PR [#427](https://github.com/alphagov/govuk-frontend/pull/427)) - Adjust `warning-text` icon by 1px for New Transport + +Internal: + - Links within the review app and the examples have been updated to use the `govuk-link` class. (PR [#427](https://github.com/alphagov/govuk-frontend/pull/427)) +- Improve documentation around contributing (PR [#433](https://github.com/alphagov/govuk-frontend/pull/433)) ## 0.0.21-alpha (Breaking release) Skipped 0.0.20-alpha due to difficulties with publishing. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 149d7f4cf7..4eba5b5cca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,14 +45,26 @@ The folder structure should be: - component-name.js - README.md +# Updating Changelog + +If you open a GitHub pull request on this repo, please update `CHANGELOG` to reflect your contribution. + +Add your entry under `Unreleased` as `Breaking change`, `New feature`, `Fix` or `Internal`. + +Please include a description of the work done and a link to the PR (see current `CHANGELOG` for the format). + +Include the modified `CHANGELOG` in the PR. + # Versioning -We use [Semantic Versioning](http://semver.org/). +We are not using semantic versioning yet, we are going to talk about this soon. + +See `CHANGELOG` for more information. ## To release a new version -To follow. +See `docs/publishing` # Commit hygiene