Gitpod-Raycast-Extension icon indicating copy to clipboard operation
Gitpod-Raycast-Extension copied to clipboard

Add Contributor stats widget to Readme

Open samad-yar-khan opened this issue 1 year ago • 5 comments

Proposed Changes

  • Add Contributor Stats widget. The widget updates every day with relevant changes dynamically. The widget improves contributor visibility.
  • The Widget is hosted by Middleware for selected open source repositories.

samad-yar-khan avatar Mar 23 '23 14:03 samad-yar-khan

Hey @henit-chobisa @Palanikannan1437 let me know if you guys like the widget or want any changes 🤖

samad-yar-khan avatar Mar 23 '23 14:03 samad-yar-khan

Hey @samad-yar-khan, thank you so much for this 🧡!

Just wanted to understand a few things...

  1. How does this work (if the frequency of updates can be customized, the flow, etc)?
  2. How many contributors would be shown?
  3. Are there any customisable params?
  4. Is there any way we can redirect to the corresponding contributors profile on clicking on them OR mention their GitHub Handles?

Palanikannan1437 avatar Mar 23 '23 15:03 Palanikannan1437

Hey @Palanikannan1437

  • The update frequency is currently set to once every 24hrs. We are looking forward top reducing this sync time if its required.
  • By Default it shows a max of 8 contributors as you can see over here for the one generated for EmbeddedChat image
  • There are customizable params, that we use internally, the number of contributors, the svg theme etc, but they are not yet public. We also have made a maintainer Widget for repo. And have themes as you can see below.

image image

We currently render two themes for contributors and a light theme for maintainer. We can actually set setting for you guys if you need. We are working on a completely dynamic svg generator engine, that will allow us render these kinds of svgs dynamically by passing any query params. We are close on that and looking forward to making it opensource :)

  • Yeah, we are thinking of adding the user names in the widget or show usernames when we hover over a contributor in the widget itself. The changes will reflect in the widget itself.

samad-yar-khan avatar Mar 23 '23 19:03 samad-yar-khan

Hey @Palanikannan1437

  • The update frequency is currently set to once every 24hrs. We are looking forward top reducing this sync time if its required.
  • By Default it shows a max of 8 contributors as you can see over here for the one generated for EmbeddedChat image
  • There are customizable params, that we use internally, the number of contributors, the svg theme etc, but they are not yet public. We also have made a maintainer Widget for repo. And have themes as you can see below. Uploading image.png…

This is super cool!! Pretty cool UI too 😍

But how would this workout 😅

Is there any way we can redirect to the corresponding contributors profile on clicking on them OR mention their GitHub Handles?

Palanikannan1437 avatar Mar 23 '23 19:03 Palanikannan1437

@Palanikannan1437 updated, my comment, I think it was saved before I finished it. The usernames in the svg or hover state should reflect in the badge itself, thats what we are planning on V2 of this. Wanted to know what would you guys prefer to have -> usernames or hove states and how strongly do we feel about adding this data. Thanks 💯

samad-yar-khan avatar Mar 23 '23 19:03 samad-yar-khan