Change merge driver for CHANGELOG.md to resolve conflict problem #3594
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently Problem
CHANGELOG.md is very often conflict when PR.
It's very troublesome.
e.g. #3588 (comment)
Solution
I've added a
.gitattributes
file.The file changes a merge driver to union for CHANGELOG.md.
The union driver has what it takes to merge CHANGELOG.md.
With the setting, CHANGELOG doesn't conflict!
Always both of the addition is chosen.
However, this solution has a problem.
GitHub doesn't support the feature.
So, We can't merge a PR at GitHub Web if CHANGELOG.md conflicts.
Don't worry,
hub
command supports the feature.Maintainer can merge a conflicted PR by hub command.
For example.
I think this method is not complete, but it is better than now.
What do you think?
More Information
Before submitting the PR make sure the following are checked:
[Fix #issue-number]
(if the related issue exists).master
(if not - rebase it).and description in grammatically correct, complete sentences.