Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Contributor stats widget to Readme #43

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

samad-yar-khan
Copy link

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
Copy link
Author

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

@Palanikannan1437
Copy link
Collaborator

Palanikannan1437 commented Mar 23, 2023

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?

@samad-yar-khan
Copy link
Author

samad-yar-khan commented Mar 23, 2023

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.

@Palanikannan1437
Copy link
Collaborator

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?

@samad-yar-khan
Copy link
Author

samad-yar-khan commented Mar 23, 2023

@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 💯

Visit our [WIP section](#wip) or [Open Issues](https://github.com/gitpod-samples/Gitpod-Raycast-Extension/issues) to contribute. Feel free to explore the project and open new issues or pull requests.

<div align='center' width='100%'>
<a href="https://www.middlewarehq.com/" target="_blank">
Copy link
Member

@axonasif axonasif Mar 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@samad-yar-khan can we do this?

Copy link
Author

@samad-yar-khan samad-yar-khan Mar 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Palanikannan1437 @axonasif At the moment we are trying to build and release an opensource project that could that could help people dynamically build these GitHub Widgets to improve contributor and maintainer visibility. We are currently hosting and updating these for select projects. Having a link to our GitHub Organization Page or Website will help other OpenSource Projects discover us and leverage the project. If the external link is a bother, can we point this to our GitHub Organization instead ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not strong opinions here 🙂
💭 Suggestion: A dedicated/customized page link for individual repos would be nicer (e.g. https://www.middlewarehq.com/<user>/<repo>) instead of just the homepage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants