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

Consider removing contribution areas from AUTHORS.rst #13090

Open
AA-Turner opened this issue Oct 30, 2024 · 4 comments
Open

Consider removing contribution areas from AUTHORS.rst #13090

AA-Turner opened this issue Oct 30, 2024 · 4 comments
Labels
type:docs type:proposal a feature suggestion

Comments

@AA-Turner
Copy link
Member

cc @timhoffm per recent discussion.

@electric-coder
Copy link

I always liked the Contributors area the way it is so IMO leave it be. LGTM.

@jdillard
Copy link
Contributor

jdillard commented Nov 7, 2024

Page in question: https://www.sphinx-doc.org/en/master/authors.html

Maybe change "Contributors" to "Notable Contributions"? I get that maintaining that list is messy per this comment, but sometimes messy is ok.

In addition, add the auto-generated list of contributors under a "Contributors" heading?

(Also, it probably won't help in this case, but a shout out to https://github.com/dgarcia360/sphinx-contributors for making it possible for Sphinx projects to attribute their contributors.)

@timhoffm
Copy link
Contributor

timhoffm commented Nov 7, 2024

"Notable Contributions" + some mention of total contributions (be it in names or stating that there are in total 743 contributors) is definitively an improvement. It gives a better perspective.

Though, what stays it the imprecision of the description of the kind of contribution, as well a subjective imbalance of "notable" (e.g. "Doug Hellmann – graphviz improvements" (7 commits) is listed, but the user jdufresne with 112 commits is not. - I haven't checked the quality of commits, but giben the significant different amount I suspect the latter should be at least as notable as the fromer).

I'd rather get rid of that as well, but if you want to keep the extra mentioning, the above propoal is the better messy one 😆.

@jdillard
Copy link
Contributor

jdillard commented Nov 7, 2024

And were the 112 commits because the PRs weren't squashed and merged vs the 7 that were. I agree it's messy. I view the "Notable Contributions" as a nice to have, but do like the idea of some type of recognition in the docs (auto-generated or not).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs type:proposal a feature suggestion
Projects
None yet
Development

No branches or pull requests

5 participants