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

Update all-contributors configuration to avoid merge conflicts #527

Closed
zeke opened this issue Oct 14, 2020 · 8 comments
Closed

Update all-contributors configuration to avoid merge conflicts #527

zeke opened this issue Oct 14, 2020 · 8 comments
Labels
engineering Will involve Docs Engineering triage Do not begin working on this issue until triaged by the team

Comments

@zeke
Copy link
Contributor

zeke commented Oct 14, 2020

When adding a new contributor to the project using @all-contributors please add @user for docs, the user's name is appended to the end of the contributors array in the .all-contributorsrc file. This is problematic because two separate PRs will likely conflict, as they are both modifying the same part of the file.

We may be able to work around this using the contributorsSortAlphabetically option, which appears to be supported by both the CLI and the GitHub bot:

cc @github/docs-engineering @janiceilene

@zeke zeke added the engineering Will involve Docs Engineering label Oct 14, 2020
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 14, 2020
@JasonEtco
Copy link
Contributor

Makes sense to me. The unintended change here would be that the core maintainers of the project aren't listed first like we are now, but I think that's okay.

@zeke
Copy link
Contributor Author

zeke commented Oct 14, 2020

☝🏼 Yeah I was thinking that. Maybe there's a hybrid way to approach this, where the source JSON data in .all-contributorsrc is alphabetized, but the avatars in the README retain their chronological order. I don't think that's supported out of the box, though. 🤔

@janiceilene
Copy link
Contributor

The readme's are the easier spot to end up with yaml mistakes when resolving conflicts. The JSON doesn't ever require any real updates. Honestly, it's annoying and unfortunate, but mostly not a real problem 🙃

@nschonni
Copy link
Contributor

Might be worth adding an auto-land action for those PRs from their bot. They the conflicts are less likely crop up then as well

@janiceilene
Copy link
Contributor

We're removing all-contributors for now 😞 Our small team just can't keep up with the (amazing!) influx of contributions. There's more details available in #576 (review) and this issue should definitely stay open so we can figure out how to resolve this complexity and get something back up and running 🙌

@nschonni
Copy link
Contributor

Probably makes sense to close the open PRs https://github.com/github/docs/pulls/app%2Fallcontributors

@nschonni
Copy link
Contributor

There are also some leftover branches in https://github.com/github/docs/branches/all

@chiedo
Copy link
Contributor

chiedo commented Nov 19, 2020

No longer using all-contributors.

@chiedo chiedo closed this as completed Nov 19, 2020
jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this issue Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engineering Will involve Docs Engineering triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

No branches or pull requests

5 participants