Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

edition.md is causing many conflicts #192

Open
joshtriplett opened this issue May 13, 2024 · 3 comments
Open

edition.md is causing many conflicts #192

joshtriplett opened this issue May 13, 2024 · 3 comments

Comments

@joshtriplett
Copy link
Member

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
Copy link
Member Author

joshtriplett commented May 13, 2024

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
Copy link
Member

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
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants