You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It solves problems for me. Copying from its README:
Change logs are [a really good idea](https://keepachangelog.com/).
Unfortunately, they are also a bit of a pain when combined with version control:
- Different merge requests all edit the same area in CHANGELOG, inevitably
resulting in merge conflicts.
- If a section for an unreleased version does not yet exist in the main branch's
CHANGELOG (typically shortly after release), feature branches must create this
section. If multiple feature branches do this, you get more merge conflicts.
- Old merge requests, when merged, sometimes add their change log entry to the
section of a release that is already published.
Life would be a lot easier if you didn't have to deal with these problems.
Enter Protokolo
([Esperanto for 'report' or 'minutes'](https://vortaro.net/#protokolo)). The
idea is very simple: for every change log entry, create a new file. Finally,
just before release, compile the contents of those files into a new section in
CHANGELOG, and delete the files.
Let's use it after the next release.
Some things that are needed:
Creating the necessary configuration with protokolo init (and manually editing CHANGELOG.md to include <!-- protokolo-section-tag -->)
Instructions in CONTRIBUTING.md
The text was updated successfully, but these errors were encountered:
I like the approach, quite simple. An alternative approach I see in projects is to generate a changelog as part of creating a release. This can be automated using tools. If we want to keep creating changelog entries as part of the pull-requests I think the approach supported by Protokolo is a nice one.
I wrote Protokolo.
It solves problems for me. Copying from its README:
Let's use it after the next release.
Some things that are needed:
protokolo init
(and manually editingCHANGELOG.md
to include<!-- protokolo-section-tag -->
)CONTRIBUTING.md
The text was updated successfully, but these errors were encountered: