From 0417b6b4e824f459de3ad57c8ba7d4ea0967329c Mon Sep 17 00:00:00 2001 From: Olivier Lacan Date: Fri, 12 Dec 2014 21:01:46 -0500 Subject: [PATCH] Add README section on 'yanked' releases. --- CHANGELOG.md | 4 ++++ README.md | 13 +++++++++++++ 2 files changed, 17 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ed908f4a..b69806c9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file. ## [Unreleased][head] - No significant changes. +## [0.0.6][v0.0.6] - 2014-12-12 +### Added +- README section on "yanked" releases. + ## [0.0.5][v0.0.5] - 2014-08-09 ### Added - Markdown links to version tags on release headings diff --git a/README.md b/README.md index 76058425..3d61ff75 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,19 @@ or contribute to it, much like [open source project badges](http://shields.io). When I refer to a "change log", I'm talking about the function of this file: to log changes. +## What about yanked releases? +Yanked releases are versions that had to be pulled because of a serious +bug or security issue. Often these versions don't even appear in change +logs. They should. This is how you should display them: + +``` +## 0.0.5 - 2014-12-13 [YANKED] +``` + +The `[YANKED]` tag is loud for a reason. It's important for people to +notice it. Since it's surrounded by brackets it's also easier to parse +programmatically. + ### How can I contribute? This document is not the **truth**; it’s my carefully considered opinion, along with information and examples I gathered.