node-triton

node-triton copied to clipboard

For node-triton we currently manually maintain a human readable CHANGES.md file that includes almost all commits. Because node-triton isn't packaged as part of Triton proper it is not included in the Triton changelog (nor does it follow the bi-weekly release process). Since CHANGES.md is modified in about the same place in every commit, every change conflicts with every other. This is a source of friction for contributors and reviewers alike.

Technical Solutions

• Create a bunch of placeholder headings after each release, change a "random" one for each change.

• Use the union merge driver for CHANGES.md. This appears to mostly work locally (minor newline cleanup required), but is not supported by JGit/Gerrit (342372, 418149).

• Place the changelog entries in a folder.

Less-Technical

• Increase the threshold for how "big" a change should be before meriting a call out in the changelog, put more of the onus on writing the changelog on the releaser, or both.

With merge=union a non-option for now, my personal view is that quirky folders or placeholders are more friction than the original conflict problem.

Example prior art for the folder approach https://pypi.python.org/pypi/blurb, very specific to CPython.