Browser-laptop: Add an about:contributors page

Created on 22 Mar 2017  ยท  14Comments  ยท  Source: brave/browser-laptop

Brave is a really unique project and we have a lot of great folks contributing to this project ๐Ÿฆ

We should be offering an about page (ex: about:contributors) to honor and give credit to all the folks who have contributed time and effort to the project. It's important to call out folks that helped with any aspect of the project:

  • Community management
  • Issue triage
  • Code
  • Testing
  • Translations
  • other

Code or project contribution information can be pulled from GitHub fairly easy, while other information (translations, triage, etc) is doesn't have a rock solid way to characterize or collect stats for. Some of the information may need to be manually collected

copcontentext documentation โœ featurabout-pages open-in-brave-core polish suggestion wontfix

Most helpful comment

I would first add github and then in next iterations add additional services.

All 14 comments

+1

@bsclifton Is there any plan How we should go for this?

@kumarrishav no plan (yet)... Do you have a proposal?

Here are a few sub-tasks we can do:

  • [ ] Create a skeleton about:contributors page (it can be empty)

  • [ ] Write a util module which queries GitHub for brave/browser-laptop and pulls contributor stats. We'd want to exclude Members of the Brave organization since this issue is focused on our awesome contributors and community ๐Ÿ˜„

  • [ ] Once we have some basic stats being fetched, I don't think it would be hard to wire that up to the about:contributors page. I'd suggest starting off by randomizing the names of the contributors and displaying them in a UL block with a format like Name shown on GitHub

@bsclifton sure, let me do some research and brainstorming on this. For now we will start with empty about:contributors page.

Should there be both code contributors and other contributors or just code contributors? Also displaying a short text of what they are doing might be one thing to add ๐Ÿ˜‰

It should be (and will be) for all type of contributors. It's just it's easy to fetch data from github and populate but for others, we are still thinking how to get their contributions. One way is manual, any ideas @Jacalz ?

I would first add github and then in next iterations add additional services.

@bsclifton @NejcZdovc @kumarrishav rough mockup for about:contributor
image

cc: @bradleyrichter for thoughts

@Jacalz +1 on what @NejcZdovc said ๐Ÿ˜„

To get started, getting the code contributors would be a first great step. The next step (which we can do concurrently, if you're interested) would be to query community.brave.com and get some of the contributor stats there.

Moving into more difficult areas:

We'll also need to find a reliable way to get the list of folks...

  • providing translations
  • helping with issue triage
  • who help with testing and quality assurance

It would be ideal if this was calculated programmatically, so that we don't have to roll up the data by hand. Any suggestions appreciated ๐Ÿ˜„

  • We might be able to gets stats on issue triage by looking at who adds labels to issues and also who closes issues (for example as dupes)
  • transifex should have an owning author for each string in our translations by language
  • QA runs all use similar titles; we could search / detect these on GitHub and look at the creator

The last three looks really promising and the community stuff would be good but it is hard updating the about:community every time somebody makes a contribution to the community if we should include stats on who has done the most ๐Ÿ˜ฌ I know @alex showed a picture of the community statistics but I don't know where to find it my self on the community itself ๐Ÿ˜… Qa should be easy and it also might be possible to create a script that looks for the test label but I don't quote me in that ๐Ÿ˜‰

I think fetching data from community would require admin access. Not sure how easy it is to pull data into about:contributor.

cc: @alexwykoff

@srirambv even if it does require admin access, once we have a Jenkins instance setup, we can pull the stats once a week and commit into the browser-laptop repo as JSON (or similar) ๐Ÿ˜„

Was this page helpful?
0 / 5 - 0 ratings

Related issues

eljuno picture eljuno  ยท  3Comments

shortstuffsushi picture shortstuffsushi  ยท  3Comments

briannyeko picture briannyeko  ยท  3Comments

octohedron picture octohedron  ยท  3Comments

mykkymk picture mykkymk  ยท  3Comments