From 5daa2fda5733538b70abe394798e8612e38c5de3 Mon Sep 17 00:00:00 2001 From: Olivier Lacan Date: Tue, 6 Oct 2015 18:53:05 -0400 Subject: [PATCH] It's not just about open source --- CHANGELOG.md | 5 +++++ README.md | 16 ++++++++-------- index.html | 16 ++++++++-------- 3 files changed, 21 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e4d948d7..f9045f35 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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?". diff --git a/README.md b/README.md index 28185de1..3f2631b2 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. @@ -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 diff --git a/index.html b/index.html index 78192e4a..cfd32747 100644 --- a/index.html +++ b/index.html @@ -21,7 +21,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.

@@ -37,7 +37,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 -(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.

@@ -103,15 +103,15 @@

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 -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!

+

This project contains what I hope will become a better CHANGELOG file convention. +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!

What should the change log file be named?