Merge attribution and contributor docs from main to 2.0 #7731
+2,554
−144
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.
This is a draft - not sure if this is a good idea. But the challenge it's trying to solve is that non-code parts of the repository will certainly diverge more frequently than it makes sense to do code merging, and already many features in 1.x that have a parallel patch in dev-2.0 achieve this through two separate PRs.
For example, the main branch is still the source of truth for contributor list, and the main place people can fix typos and make translation suggestions. Ideally, dev-2.0 does not lag behind.
In this commit: tone that unit testing has an extra section in dev-2.0 but not in main - does it make sense to actually have that section on both branches, and indicate it has to do with 2.0? Does that make it more or less readable / locatable, since navigating these .md files on github initially presumes main tree, not a specific branch tree.
This idea occurred when I was experimenting with cherrypicking only those commits that do not touch src/ or test/:
(Technically should also have excluded package.json and test, but the following issue would still apply.) This approach does not work, because it removes too many commits - from the total 170+, only a dozen remained. Seems quite a few commits do not isolate code/tests/contributor docs, so the result did not look reasonable. Literally cherrypicking commits touching all-contributors list and README is extremely effort-intensive because there's a merge conflict almost every time - Unless I'm missing something?
I also did try to just include patches of commits just over these sets of files:
But the result was very unconvincing, it seemed more likely to lead to bigger github problems later on, because excluding the parts of commits that impacted src or test directories would have to be done manually. It seemed very fragile as an approach.
So this was my solution to the problem of cherry-picking commits involving attribution list and contributor docs specifically, which are parts of the repository that will need to be kept consistent between the branches. on a regular basis I'm not attached to this approach, but I do think it would be great to have a way to quickly keep the branches up to date documentation-wise!