keep-a-changelog
keep-a-changelog copied to clipboard
olivierlacan
If you build software, keep a changelog.
Here are my 2 cents, First, I'm the author of `gitchangelog` which will "dump git logs into your changelog". But I feel somewhat that we are chasing the same rabbit....
As a project developer, I want to provide changelog to other developers (by convention in English) and to clients/end consumers (in their own native language). So that both developers and...
What if I want to mention any changes to the build requirements or dependencies of the project? In what section do I put the following text: - The project now...
I understand that changelogs document changes that the users care about, and that usually, internal implementation details don't fall into that category. However, I think that sometimes internal changes are...
In trying to comprehend what the actual format is outside of the hosted example. I think it would help if common spec (aka legal) wording were to be used. eg....
I would appreciate some hints how to write changelog entries, similar to [The seven rules of a great Git commit message](https://chris.beams.io/posts/git-commit/#seven-rules).
There's already a standard that is at least somewhat widely used in the Perl community. See https://metacpan.org/pod/CPAN::Changes::Spec for details. It's a bit looser than what you propose, but the ideas...
Would it be useful for a Changelog to have a known issues section? For example, I'm committing a change and know it's not perfect, and will break under these situations...
Hi, The [Unreleased] section is not clear to me. > Keep an Unreleased section at the top to track upcoming changes. To me, "Unreleased" means that the changes do exist,...
Hey all, I love the Keep-A-Changelog project and the format, but I hate dealing with merge conflicts due to the `Unreleased` section of the changelog. To solve this issue my...
