Create a contributors / credits page

[AbdBarho]

This project has gathered a lot of community contributors in a very short time span.

The names of everyone who contributed should be eternalized on our app and website, with extra bells and whistles for long time team members!

[JoLalo]

Hi, I can try to help you with this. I don't know how this works regarding communications so I'll just write a comment.

[JoLalo]

Hi! Thank you for assigning me to this project. To make this easier, can I add one of you on discord to get a better understanding of what I need to do?

[bitplane]

I would guess there's several parts, which might be best done as separate tickets to keep the work nice and small

1. Developers
2. GitHub contributors
3. Data contributors
4. Others

Developers

Pretty easy to do in code. You can list commits by developers like this:

git --no-pager log --format="%aN"

This would give you a list sorted by number of commits:

git --no-pager log --format="%aN" | sort | uniq -ic | sort -nr

Dump it to a file (.gitignore it) then make a script that saves the output to a Markdown file in the docs dir. Mustache templates are pretty nice for this sort of thing, dunno if we're already using them. (git-python is probably nicer than using bash as above)

GitHub contributors

Use the github API to pull user display names from all the github issues

Data contributors

A script that grabs the leaderboards from the live site and adds them into the template variables. We should probably ask people if/how they want to be credited though?

Others

Probably need a special section for people who help in other ways, like compute donations, downstream models etc

Automating it

Dunno about this. Should probably be part of the release/deploy process rather than on a commit or push hook, or maybe run it ad-hoc.

[KyleGrande]

Interested in working on this if still possible.

[theopfr]

Hey, any update on this? Just in case no one is working on this: I created something. Is this what you had in mind? It's basically just a clone of the GitHub contributors page displaying the names and amount of commits.

I noticed that the GitHub API is strictly rate-limited therefore Im not sure if this will lead anywhere. I think that the OA would have to be registered at the GitHub API in order to get an API key. I could keep working on this if the rate-limit issue would be resolved. :)

[AbdBarho]

@theopfr this is great! could you please create a PR with the react components? we are planning on letting team members add themselves manually to this list (instead of using the api).

[theopfr]

Glad you like it. So, should just the names be displayed then? Maybe the team members can provide their usernames and github id. Its possible to get the avatar using this url: https://avatars.githubusercontent.com/u/{id} (as long this isn't also rate-limited but I don't think so). Additionally, the name can function as a Link to the Github account. Sound good?

Ah and should the names/ids just be added to a TS array inside the component or do we want to store them somewhere else and then fetch it?

[AbdBarho]

@theopfr I have a very basic page setup in #2103, the data is in the file website/src/data/team.json.

I say we can merge #2103 first, then you can replace my UI with yours, or combine them if you want to.

[theopfr]

yes sounds good, I'm updating my component now given the data in the team.json, I'm orienting it after yours, it will be very similar.

[theopfr]

okay so in the end my code does almost exactly what yours does but is probably less readable, therefore after you merged #2103 I'd just make/propose two cosmetical changes but keep yours.