Skip to content

Commit

Permalink
It's not just about open source
Browse files Browse the repository at this point in the history
  • Loading branch information
olivierlacan committed Oct 6, 2015
1 parent 3e1fe1e commit 5daa2fd
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 16 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]

## [0.2.0] - 2015-10-06
### Changed
- Remove exclusionary mentions of "open source" since this project can benefit
both "open" and "closed" source projects equally.

## [0.1.0] - 2015-10-06
### Added
- Answer "Should you ever rewrite a change log?".
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### What’s a change log?
A change log is a file which contains a curated, chronologically ordered
list of notable changes for each version of an open source project.
list of notable changes for each version of a project.

<a href="CHANGELOG.md" title="An example of a CHANGELOG file."><iframe src="CHANGELOG.md" width="570" height="350" seamless="seamless" style="border: 1px solid #aaa; padding: 1em; margin: 0 0.5em;"></iframe></a>

Expand All @@ -18,7 +18,7 @@ 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 open source maintainers and
(fitting, right?) podcast about why maintainers and
contributors should care, and the motivations behind this project.
If you can spare the time (1:06), it’s a good listen.

Expand Down Expand Up @@ -74,16 +74,16 @@ or a pull request.
### Is there a standard change log format?
Sadly, no. Calm down. I know you're furiously rushing to find that link
to the GNU change log style guide, or the two-paragraph GNU NEWS file
"guideline". The GNU style guide is a nice start but it is naive.
"guideline". The GNU style guide is a nice start but it is sadly naive.
There's nothing wrong with being naive but when people need
guidance it's rarely very helpful. Especially when there are many
situations and edge cases to deal with.

This project [contains what I hope will become a better CHANGELOG file convention][CHANGELOG]
for all open source projects. Can the open source community learn from
its mistake and not act as if the ten commandments were written long ago
and got everything right? Alright. So please take a look around and
remember that [discussions and suggestions for improvements are welcome][issues]!
This project [contains what I hope will become a better CHANGELOG file convention][CHANGELOG].
I don't think the status quo is good enough, and I think that as a community we
can come up with better conventions if we try to extract good practices from
real software projects. Please take a look around and remember that
[discussions and suggestions for improvements are welcome][issues]!

### What should the change log file be named?
Well, if you can’t tell from the example above, `CHANGELOG.md` is the
Expand Down
16 changes: 8 additions & 8 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h3 id="what-s-a-change-log-">
What’s a change log?
</h3>
<p>A change log is a file which contains a curated, chronologically ordered
list of notable changes for each version of an open source project.</p>
list of notable changes for each version of a project.</p>
<p><a href="CHANGELOG.md" title="An example of a CHANGELOG file."><iframe src="CHANGELOG.md" width="570" height="350" seamless="seamless" style="border: 1px solid #aaa; padding: 1em; margin: 0 0.5em;"></iframe></a></p>
<h3 id="what-s-the-point-of-a-change-log-">
<a name="what-s-the-point-of-a-change-log-" class="anchor" href="#what-s-the-point-of-a-change-log-"></a>
Expand All @@ -37,7 +37,7 @@ <h3 id="why-should-i-care-">
you contributing to open source? Surely, 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
(fitting, right?) podcast about why maintainers and
contributors should care, and the motivations behind this project.
If you can spare the time (1:06), it’s a good listen.</p>
<h3 id="what-makes-a-good-change-log-">
Expand Down Expand Up @@ -103,15 +103,15 @@ <h3 id="is-there-a-standard-change-log-format-">
</h3>
<p>Sadly, no. Calm down. I know you&#39;re furiously rushing to find that link
to the GNU change log style guide, or the two-paragraph GNU NEWS file
&quot;guideline&quot;. The GNU style guide is a nice start but it is naive.
&quot;guideline&quot;. The GNU style guide is a nice start but it is sadly naive.
There&#39;s nothing wrong with being naive but when people need
guidance it&#39;s rarely very helpful. Especially when there are many
situations and edge cases to deal with.</p>
<p>This project <a href="./CHANGELOG.md">contains what I hope will become a better CHANGELOG file convention</a>
for all open source projects. Can the open source community learn from
its mistake and not act as if the ten commandments were written long ago
and got everything right? Alright. So please take a look around and
remember that <a href="https://github.com/olivierlacan/keep-a-changelog/issues">discussions and suggestions for improvements are welcome</a>!</p>
<p>This project <a href="./CHANGELOG.md">contains what I hope will become a better CHANGELOG file convention</a>.
I don&#39;t think the status quo is good enough, and I think that as a community we
can come up with better conventions if we try to extract good practices from
real software projects. Please take a look around and remember that
<a href="https://github.com/olivierlacan/keep-a-changelog/issues">discussions and suggestions for improvements are welcome</a>!</p>
<h3 id="what-should-the-change-log-file-be-named-">
<a name="what-should-the-change-log-file-be-named-" class="anchor" href="#what-should-the-change-log-file-be-named-"></a>
What should the change log file be named?
Expand Down

0 comments on commit 5daa2fd

Please sign in to comment.