Skip to content

Commit

Permalink
Add "Why should I care?" section and mention The Changelog.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
olivierlacan committed Aug 9, 2014
1 parent b8225fe commit 970338d
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 4 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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?
Expand Down
12 changes: 10 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ <h3>What&#39;s a CHANGELOG?</h3>
<h3>What&#39;s the point of a CHANGELOG?</h3>
<p>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.</p>
<h3>Why should I care?</h3>
<p>Well, because software tools are for people. If you don&#39;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.</p>
<p>I <a href="http://5by5.tv/changelog/127">talked with Adam Stacoviak and Jerod Santo on The Changelog</a>
(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&#39;s a good listen.</p>
<h3>What makes up a good CHANGELOG?</h3>
<p>I&#39;m glad you asked.</p>
<ul>
Expand Down Expand Up @@ -48,8 +56,8 @@ <h3>What makes unicorns cry?</h3>
(&quot;06-02-2012&quot; for June 2nd, 2012, which makes <em>no</em> sense), while Brits
use a robotic-looking &quot;June 2 2012&quot;, yet pronounce it &quot;June 2nd, 2012&quot;.</li>
</ul>
<p>There&#39;s more. Help me collect those unicorn tears by
<a href="https://github.com/olivierlacan/keep-a-changelog/issues/new">opening an issue</a>
<p>There&#39;s more. Help me collect those unicorn tears by
<a href="https://github.com/olivierlacan/keep-a-changelog/issues/new">opening an issue</a>
or a pull request.</p>
<h3>Is there a standard CHANGELOG format?</h3>
<p>Sadly, no, but this is something I want to change. This project
Expand Down

0 comments on commit 970338d

Please sign in to comment.