From 970338d437de20d9dd7dae1be1fc90752b91f42a Mon Sep 17 00:00:00 2001 From: Olivier Lacan Date: Sat, 9 Aug 2014 19:14:36 +0900 Subject: [PATCH] Add "Why should I care?" section and mention The Changelog. I figured adding this section was notable enough to make a new CHANGELOG entry as well. The podcast is a bit long so I don't expect people new to this project to actually listen to it right away but it would be good to extract some of the good points made on the show into more fuel to the fire. --- CHANGELOG.md | 14 ++++++++++++++ README.md | 14 ++++++++++++-- index.html | 12 ++++++++++-- 3 files changed, 36 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c3dc5efe..f193150e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,20 @@ # Changelog All notable changes to this project will be documented in this file. +## 0.0.3 - 2014-08-09 + +### Added +- "Why should I care?" section mentioning The Changelog podcast. + +### Deprecated +- Nothing. + +### Removed +- Nothing. + +### Fixed +- Nothing. + ## 0.0.2 - 2014-07-10 ### Added diff --git a/README.md b/README.md index 06801ab9..7aad855e 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,16 @@ list of notable changes for each version of an open source project. To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. +### Why should I care? +Well, because software tools are for people. If you don't care, why are +you contributing to open source? There must be a kernel (ha) of care +somewhere in that lovely little brain of yours. + +I [talked with Adam Stacoviak and Jerod Santo on The Changelog](http://5by5.tv/changelog/127) +(fitting, right?) podcast about why open source maintainers and +contributors should care, and the motivations behind this project. If +you can spare the time (1:06), it's a good listen. + ### What makes up a good CHANGELOG? I'm glad you asked. @@ -42,8 +52,8 @@ another it should be painfully clear when something will break. ("06-02-2012" for June 2nd, 2012, which makes *no* sense), while Brits use a robotic-looking "June 2 2012", yet pronounce it "June 2nd, 2012". -There's more. Help me collect those unicorn tears by -[opening an issue](https://github.com/olivierlacan/keep-a-changelog/issues/new) +There's more. Help me collect those unicorn tears by +[opening an issue](https://github.com/olivierlacan/keep-a-changelog/issues/new) or a pull request. ### Is there a standard CHANGELOG format? diff --git a/index.html b/index.html index fc498c59..beec6af5 100644 --- a/index.html +++ b/index.html @@ -17,6 +17,14 @@

What's a CHANGELOG?

What's the point of a CHANGELOG?

To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.

+

Why should I care?

+

Well, because software tools are for people. If you don't care, why are +you contributing to open source? There must be a kernel (ha) of care +somewhere in that lovely little brain of yours.

+

I talked with Adam Stacoviak and Jerod Santo on The Changelog +(fitting, right?) podcast about why open source maintainers and +contributors should care, and the motivations behind this project. If +you can spare the time (1:06), it's a good listen.

What makes up a good CHANGELOG?

I'm glad you asked.

-

There's more. Help me collect those unicorn tears by -opening an issue +

There's more. Help me collect those unicorn tears by +opening an issue or a pull request.

Is there a standard CHANGELOG format?

Sadly, no, but this is something I want to change. This project