Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hooopo/repo-contributor-circles

GitHub repo contributor circles generator.
https://github.com/hooopo/repo-contributor-circles

github github-actions tidb visualization

Last synced: 26 days ago
JSON representation

GitHub repo contributor circles generator.

Awesome Lists containing this project

README 

        
# Repo Contributor Circles



**Repo Contributor Circles** is a fascinating visualization tool designed to exhibit the contributors of a particular GitHub repository in a unique, circle layout representation. The contributors are ranked based on the number of pull requests, offering a quick and visually engaging way to understand the active contributors to a project.



![](/circle.png)



The incredible graphical image generated by **Repo Contributor Circles** serves multiple purposes. Not only does it give you a snapshot of the contributors and their level of involvement in your repository, it also fosters a strong sense of community by recognizing the hard work and dedication of each contributor.



Key features of **Repo Contributor Circles** include:



- Display of contributors in a circular layout

- Ranking of contributors based on the count of pull requests

- Easy to share representation on social media

- A fantastic addon to a project's GitHub README to visualize the contributor community



**Repo Contributor Circles** presents a novel way to appreciate and highlight the individuals who are shaping your project. Use this tool today to transform your list of contributors into an engaging visualization that tells the story of your repository's community.



## How to setup "Repo Contributor Circles" for youself



1. **Fork the repository**: Start by forking this repository to your own GitHub account using the "Fork" button at the top right corner of the repository page.



2. **Fill secrets for GitHub Actions**: In the "Settings" tab of your forked repository, navigate to "Secrets" and add the following secrets:



   3.1. `REPO_FULL_NAME`: Your target repo fullname, for example: `pingcap/tidb`.

   

   3.2. `DATABASE_URL`: Register for TiDB Serverless and get the connection info. You can register here: [TiDB Serverless Registration](https://tidbcloud.com/?utm_source=github_circles&utm_medium=github_circles&utm_campaign=github_circles)



   Format of the connection info: `mysql2://:@:/`



3. **Enable GitHub Actions**: Navigate to the "Actions" tab in your forked repository, and click on the green "I understand my workflows, go ahead and enable them" button to enable GitHub Actions.



![image](https://github.com/hooopo/oh-my-github-circles/assets/63877/5b1b31b8-bfc7-416d-917c-8e6403b419ac)



Next:



![image](https://github.com/hooopo/oh-my-github-circles/assets/63877/28f90221-e463-4f44-8f35-4f4eaa2cbac1)



4. **Manually trigger the first GitHub Action**: Go back to the "Actions" tab in your forked repository, choose the workflow you want to run, and click the "Run workflow" button to manually trigger it for the first time.



![image](https://github.com/hooopo/oh-my-github-circles/assets/63877/d883ab0b-e9d6-40a7-a9a5-dd3ae87c58fc)



5. **Get the image URL or copy the image**: Once the GitHub Action has been successfully executed, you can either get the image URL or copy the generated image directly.



Follow these steps, and you'll successfully set up "Repo Contributor Circles" for your repository.



## Special Thanks



_Repo Contributor Circles_ was inspired by [**Chirpty**](https://chirpty.com/), a similar visualization project for Twitter profiles. We would also like to express our gratitude to the following projects and services that played a crucial role in the development and implementation of _Oh My GitHub Circles_:



1. **repo-track-pipeline**: Our project depends on the [repo-track-pipeline](https://github.com/hooopo/repo-track-pipeline) which is responsible for processing and transforming the GitHub repo data.



2. **GitHub Actions**: [GitHub Actions](https://github.com/features/actions) automates the entire workflow of our project, making it easy to build, test, and deploy the visualizations on demand.



3. **TiDB Serverless**: We leverage [TiDB Serverless](https://tidbcloud.com/?utm_source=github_circles&utm_medium=github_circles&utm_campaign=github_circles) for seamless database management and highly efficient data handling, enabling a smooth user experience.



## Related repos



* [Oh My GitHub Circles](https://github.com/hooopo/oh-my-github-circles)

* [Oh My GitHub Pipeline](https://github.com/hooopo/oh-my-github-pipeline)

* [Repo Contributor Circles](https://github.com/hooopo/repo-contributor-circles)

* [Repo Track Pipeline](https://github.com/hooopo/repo-track-pipeline)

* [OSSInsight Lite](https://github.com/pingcap/ossinsight-lite)

* [OSSInsight](https://github.com/pingcap/ossinsight)

* [Hackernews Insight](https://github.com/hooopo/hackernews-insight)

* [Oh My GitHub Dashboard](https://github.com/hooopo/oh-my-github-dashboard)



## Contributing



Contributions are always welcome! Feel free to fork the repo, make changes, and create pull requests.



## License



This project is open-source and available under the MIT License. See the [LICENSE](LICENSE) file for more information.