search

carpentries / glosario

A multilingual glossary for computing and data science terms.
https://glosario.carpentries.org
Other
106 stars 227 forks source link

2020-10-15: add list of contributors #134

Open fmichonneau opened 4 years ago

fmichonneau commented 4 years ago

A list of contributors to the glossary should be included on the site.

baileythegreen commented 3 years ago

@fmichonneau Are you thinking on a separate page linked from the main one, on the main page, et cetera? And how broadly do you want to interpret 'contributor'? The broadest definition would probably be anyone who has submitted a PR, but unless there is a way to generate an automated list (this is a possibility) this is not trivial to maintain. The narrowest would be a page on the Editorial Team, though this probably makes sense to have in general, aside from acknowledging non-editorial contributors.

The auto-add-contributors job can be customised so we can place its output somewhere that is not the Readme.

fmichonneau commented 3 years ago

I didn't think too much about the exact details of the implementation but I thought contributors could be listed on the landing page at the bottom. Yes, I was thinking anyone who has contributed to a PR should be listed. I like the idea of also listing editors. I was certainly thinking of using a GitHub action to take care of this.

baileythegreen commented 3 years ago

I've been playing around with that action, and this is what I have so far for a contributors page. I've submitted a PR to the Action's repo to get the spacing between rows changed, and see if they can wrap the longer names.

Screen Shot 2020-12-07 at 10 42 04

I've also looked into how a list of Editors could be done. This action uses the Python Github module to access a particular repo. Accessing a team and its members programmatically may be possible with the same library, but I do not yet know how. I have managed to do so using the github3.py module and a personal access token, but I think one of Glosario's admins would need to set up a token for this use. I am also not sure how to make sure the Action script has access to this other Python module.

Of course, there are other, less automatic ways to generate an editors section, and as the editors are smaller in number and (presumably) change less frequently than the contributors, this might be reasonable.

But, however it's done, once we can access the team's members inside Python (what the action's main script is written in) some slight additions to the code would be sufficient to add the editors first, then in the contributors section, as the loop runs, compare each contributor to a set of the editors and only print the others.

fmichonneau commented 3 years ago

there is also this one: https://github.com/all-contributors/all-contributors edit: and this one: https://github.com/con/tributors

baileythegreen commented 3 years ago

I have experience with all-contributors, which I would not recommend. It was added to a repository where I had commented on a small number of things, and after it was added, I got 80 useless emails from it in the space of an hour.

I can look into the second one, although I have already gotten a version with add-contributors working, with better spacing of the images and wrapping of long names — I'm just working on fitting it into the site styling and adding suitable links to the contributors' page. It's almost ready for a PR.

fmichonneau commented 3 years ago

Great! I'm looking forward to seeing it!

elletjies commented 3 months ago

@baileythegreen I know this thread is almost 4 years old but would like to check in if you have worked on the PR you mentioned above. We have been embarking on a Glosario CodeFest during 2024 and would love to show appreciation (through the list of contributors you mentioned).