executablebooks / github-activity

Simple markdown changelogs for GitHub repositories
https://github-activity.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
47 stars 11 forks source link

Output a list of contribution types for each contributor rather than a flat list #68

Open choldgraf opened 1 year ago

choldgraf commented 1 year ago

Context

Currently, we define "a contributor" as somebody that fits one of several criteria (reference here):

People that fit any of these criteria are added to the contributors list. As a result, these lists can be really long and it's a bit unclear who did what within that group.

Many projects like All Contributors instead explicitly list the contributions that each person makes. I wonder if we could do something similar here.

Proposal

However, it might be easier for us to include more varied kinds of contributions if we just made it explicit what kinds of contributions each contributor made. Since we are already calculating this for each contributor above, we could add a little "emoji" for each type of contribution within a release, rather than using a single flat list. This might be a way of providing a bit more information than just one giant flat list of people.

So the output of ### Contributors might be a table where the first column is the username, and the second column is a list of emojis or words that describe the kinds of contributions they made within that release.

Tasks and updates

No response