fmt-rfcs icon indicating copy to clipboard operation
fmt-rfcs copied to clipboard

`edition.md` is causing many conflicts

Open joshtriplett opened this issue 1 year ago • 3 comments

In the style guide, the edition.md documentation for changes in each edition is effectively a changelog, and like any changelog, it causes merge conflicts on almost every change.

A merge driver isn't sufficient to solve those conflicts, because GitHub doesn't use merge drivers (even built-in ones).

We should come up with some other way to avoid encountering conflicts with every single edition change.

joshtriplett avatar May 13 '24 15:05 joshtriplett

One option might be to put three blank lines between each bullet point.

Another might be to put two blank lines, and see if GitHub allows one line of "fuzz" when applying a patch. I haven't found any documentation indicating how much fuzz GitHub allows; this would need testing.

joshtriplett avatar May 13 '24 15:05 joshtriplett

Until such time as we come up with a solution to this, what if we just externalized the changes somewhere (e.g. GitHub issues, Hackmd, etc.) and then once done (or even periodically) we updated the in-repo edition.md file?

calebcartwright avatar May 15 '24 19:05 calebcartwright

@calebcartwright That might be a reasonable option, if we can't find a transparent solution (e.g. spacing things out).

joshtriplett avatar May 15 '24 21:05 joshtriplett