make a list of contributors #4508
Conversation
|
I do not like the "Authors / Contributors" title, because some contributors did not commit code/docs: they filed bugs, reviewed code/docs, helped design, wrote widely read documentation not included in the repo, etc. and free software communities have a tendency to (not sure the best wording) marginalize / not recognize those contributions/contributors, and this title does that by implying that people not on this list are not contributors. I'd at least change the title to something like "Commiters", and at most, something like "Commiters. Look online to find the many valuable contributors who have not commited code." |
|
Good point @ian-kelling. If you can think of a way to find a list of people who contributed outside of committing code, I'd be happy to include them |
The information can almost entirely be found from search engines and a few sites like github, but it's not easily automated and I doubt anyone wants to do that work, so I think it's probably better to simply tweak the title in some way as I suggested. |
There was a problem hiding this comment.
You should do what you think is best here, but a few suggestions:
- Perhaps we should remove people's e-mail. I can't imagine (m)any people getting frustrated we didn't include their e-mail, but I can imagine a few getting frustrated that we did.
- You can do what you want in response to @ian-kelling's insightful comments, but perhaps you can workaround the problem by just titling the page "Authors" which I think helps clearly designate this is people who wrote Certbot code. If you want to and can find the time to pull people's names from GitHub comments, you could change it to the more general contributors.
- Most of these files I've seen are in the root of the repo with a name like
AUTHORS.rst,CONTRIBUTORS.rst. Perhaps we should do this as well.
Feel free to ignore my comments if you want and I'm happy to give this a +1 whenever.
|
I'm ... going through and making github links for all the ones I can find |
|
That sounds...painful. Again, feel free to ignore my suggestion and just leave the e-mail address if you want. I only said it because we'll be putting people's e-mail addresses in an easily scrapeable file, but it's already in our git history and plenty of other repos do it. |
|
done! check it out!! |
docs/contributors.rst
Outdated
| @@ -0,0 +1,272 @@ | |||
| Authors / Contributors | |||
There was a problem hiding this comment.
This file should be removed, right? (It appears to be a duplicate, but with emails.)
|
@zjs should be fixed now |
AUTHORS.md
Outdated
| * [Erica Portnoy](https://github.com/ohemorange) | ||
| * [Erik Rose](https://github.com/erikrose) | ||
| * [Eugene Kazakov](https://github.com/xgin) | ||
| * [Giovanni Pellerano](https://github.com/evilaliv3) |
There was a problem hiding this comment.
Not to nit this point too much, but the sorted order still seems off. This line is one example.
fixes #211
made by running
git shortlog --summary --emailand then doing some cleanupI optimized for non-gmail address and instead opted for work or personal website emails. That said it still probably has a lot of addresses in it that people might not like being posted publicly (even though they are already in the git history...)