Answer what, why, who, and how

The previous version was very wordy. Let’s get to it.
This commit is contained in:
Olivier Lacan 2017-04-27 12:14:54 -07:00
parent 6448642978
commit 7af2d256ea
1 changed files with 16 additions and 13 deletions

View File

@ -13,27 +13,30 @@ version: 0.4.0
Version **#{current_page.metadata[:page][:version]}**
### Whats a changelog?
A changelog is a file which contains a curated, chronologically ordered
list of notable changes for each version of a project.
### Why keep 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.
### Who needs a changelog?
People do. Whether consumers or developers, the end users of software are
human beings who care about what's in the sofware. When the software changes,
people want to know why and how.
### How do I make a changelog?
Let's look at our own changelog as an example:
<pre class="changelog">#{File.read("CHANGELOG.md")}</pre>
### Whats 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?
Because software tools are for people. If you dont care, why are
you contributing to open source? Surely, 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][thechangelog]
(fitting, right?) podcast about why maintainers and
contributors should care, and the motivations behind this project.
If you can spare the time (1:06), its a good listen.
### What makes a good changelog?
Im glad you asked.
A good changelog sticks to these principles: