-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Acknowledge maintainers and major contributors in the readme #11187
Comments
Sounds good, should be on bottom. can be pretty long list. Should they show with avatar or a simple list? 🤔 |
There's a bot that you could use to automate this work, it's called
You can give commands like: @all-contributors please add @HonkingGoose for ... You can see how such a PR looks over here: https://github.com/testing-library/eslint-plugin-testing-library/pull/436 If you don't want to add this bot (needs |
I like that bot. 🙃 |
I think we should use a |
So topics are:
BTW my purpose was to explicitly highlight/thank those who have contributed the most. |
If that's all you want/need to do, you can do that by hand, and update the section when needed. I've ran
Seems we need to thank the creator first, then our robot friends/overlords, and then the rest of the maintainers/contributors. 😄 🤪 |
Thanks for thinking about this! I like the idea of |
Use bot to automate adding peopleI've tested the The Manually seed list with valuable contributors/maintainersIf we only care about people who have contributed the most or most meaningfully, a manual migration is feasible. I'm willing to make a PR that adds all people with more than 10 commits to the list using the CLI tool myself. 😉 After that we use the CLI tool to add new contributors, or tell contributors to add themselves. 😉 |
@HonkingGoose did you have any ideas about which file to put it in? I think I'd prefer to avoid bloating our |
If you want the Renovate project to use the All Contributors CLI:
https://allcontributors.org/docs/en/cli/configuration If you want to use the bot, the JSON file is also called
https://allcontributors.org/docs/en/bot/configuration So if you want to use the CLI or bot here's what I would do:
|
Sounds great! I like using the bot |
@rarkins Do you want a migration PR from me? |
sure, if you able / have time to do it 🙃 |
I'll go try to migrate us then. 😄 |
This comment has been minimized.
This comment has been minimized.
Options researchedI researched the following options to add contributors in a somewhat automatic way:
Rejected options:
Chosen option (for now):Which leaves us with option 4: Do nothing and wait for the ecosystem/tooling to improve. Status of issue:I'm going to consider this |
Thanks for the deep research @HonkingGoose 👍 I’m wondering how hard it would be to write a tiny GH action that adds the contributor to the PR branch 🤔 |
@fgreinacher You mean like a action that does something like this? git clone pr-branch
yarn install
yarn all-contributors add username for emoji-key
git commit -m "chore: add username for emoji-key
git push pr-branch You need a way to know what kind of contribution you want somebody to be added for.
We'd also need to account for the case where people are already on the list, like if it tries to add me again for a But then you're basically duplicating part of the code for the Note that this setup would only automate for things like code, docs, test, refactorings that happen via commits to the |
Also, I'm not sure any action that originates from Also, I'm not sure that we can use |
It would need to run as a maintainer PAT, which is a security risk |
Oh okay, so pushing changes to a fork is right out... 😄 |
Valid arguments, probably it's really not worth the effort here 😀 I guess the repository pulse has most information one might need. Seeing how the whole |
User-created script to add old contributors (no license!)
There now is an automated way to migrate old contributions, see: all-contributors/all-contributors#539 (comment) for the discussion + link to a Python script. There's no license attached to the script, so I don't think we can use it under our own license. It will still be hard for newcomers to add themselves even after we do the automatic insertion. So that part is still a blocker. New idea: use script yearly to add all contributorsWe could go for a totally new approach, where we only update the list of all contributors once a year. This means that we don't have any noise, don't need to tell our contributors to do something complicated to add themselves, and we credit any new contributions in the last year. Let me know what you think! 😄 |
Sure, sounds good. It will be manual and subjective but that's probably OK. I'd likely just go through the list of |
Option 1: automatic script by somebody else
I worry that if I try to integrate the custom code to list the contributors in our README.md that I'll get stuck and need help from others. So if we want to go this route, I'll need somebody else to get it working. 😄 Option 2: go full manualI think I'd rather edit the
Decision on direction by @rarkinsWhich of these options do you like best @rarkins? |
I think I'd like to go with full manual mode. It would be good to note whenever there's someone actively maintaining certain modules or logic (e.g. @secustor is reliably available for Terraform topics), plus notable feature contributions in the past. |
Do we want to overload our readme with a "thanks" section though? If we're going full manual anyway, why not make it really cool and publish our thanks in the docs? We now have a About Us page that I could expand, or I can create a new file called |
True, docs would be great |
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
I think we can reuse Here's what I'm thinking: We can list @viceice , @JamieMagee and myself as maintainers, no need for further details. There's maybe around 5 people who have helped maintain certain features specifically, and that deserves a special thanks next. @HonkingGoose you are obviously the master of the docs, but I'd also propose you think of a term for yourself in addition such as "Community manager". @zharinov has focused on parsing, Gradle, Maven, and he can remind me of other features. @secustor Terraform, I think a couple of others. @fgreinacher I recall some NuGet stuff in particular, any others areas you are happy to note as available for review/assistance? @Turbo87 has helped in multiple areas, especially Cargo. @ikesyo has been regularly helpful, as is @astellingwerf. I'm not sure what they'd list as their specialities. Then finally there should be a section to pay thanks to those who've made valuable contributions in the past, even if one-offs. Some features made a lot of people happy and efficient! I would include for example the work of @danports here, unless he's happy to list himself as a "regular" contributor/advisor on any topics like Flux. I think let's get it started, even if we accidentally/embarrassingly leave out anyone to begin with, we will fix it later. |
Sounds good to me! I'll start working on this. 😉 |
Thanks for thinking of me! Feel free to mention me for NuGet, sure. |
No need for acknowledgement here, but if it floats your boat to add me to a list somewhere, go for it. I haven't really been active since the Flux manager (and all of the others!) has been working well for me, but if there is an issue/PR that is Flux-related, feel free to tag me. Subscribing to all issues/PRs for the repo is kind of noisy (maybe a CODEOWNERS file could help?). |
I don't subscribe to all issues/PRs/comments as well, as that floods me with too many messages. 😄 The CODEOWNERS file only pings people with at least
|
🎉 This issue has been resolved in version 32.66.5 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
This is an open source project and I'd like to acknowledge and thank the contributors in the readme. This includes my fellow maintainers (@viceice @JamieMagee) as well as active and repeat contributors such as @HonkingGoose @secustor @ikesyo @zharinov @fgreinacher. We can also have a section to thank those who made significant contributions in the past but have now decreased their involvement for whatever reason so we can avoid any awkward feelings of "dumping" someone from the list who is not contributing enough. Some may even move themselves between sections ;)
Thoughts?
The text was updated successfully, but these errors were encountered: