rust-lang / style-team

Home of the Rust style team
Apache License 2.0
453 stars 56 forks source link

`edition.md` is causing many conflicts #192

Open joshtriplett opened 3 months ago

joshtriplett commented 3 months ago

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 commented 3 months ago

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.

calebcartwright commented 3 months ago

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?

joshtriplett commented 3 months ago

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