4 ms·
I'm aware of hundreds if not thousands of projects on GitHub alone using similar ways of documenting changes with CHANGELOG-like files and regardless of their s
by olivierlacan 10y ago
I'm aware of hundreds if not thousands of projects on GitHub alone using similar ways of documenting changes with CHANGELOG-like files and regardless of their size/popularity I'm not aware of the issues you both seem to be worried about.
Generally people edit changelogs after pull requests have been merged or as part of the pull requests themselves. It's far easier to figure out merge conflicts if and when other versions appended to the changelog simultaneously because all changelog entries are dated (or at least they should be) or at least versioned and contain plain text.
That said I agree that we should probably spend some time detailing common processes for editing and appending to a changelog in situations with concurrent branches being developed.
- hadley 10y agoThis is a real issue. I ask contributers to add a bullet at the top of NEWS.md and I frequently have to manually fix merge conflicts. This is only a problem if you're handling multiple PRs simultaneously so your project has to reach a certain level of use before you'll see it.