Thanks, Contributors!

thanks-contributors是一个自动统计组织或多个项目贡献者的开源工具

English - 文档 - 主页

✨功能

• 可自定义单仓库或多仓库组合的贡献者统计
• template一键配置, 默认统计仓库所在用户的所有公开仓库
• 支持Github Action和本地使用
• 支持Github Pages自动部署&同步更新
• 支持贡献者图片墙和Markdown贡献者列表两种格式

应用场景 & 案例

• 个人主页 : 显示个人维护的所有仓库和组织 & 案例的贡献者 -> Sunrisepeak
• 组织主页 : 显示组织下所有仓库的贡献者 -> mcpp-community
• 单个或多个仓库 : 显示单个仓库的贡献者

快速开始

方式一: 直接使用项目模板

• 1.通过创建thanks-contributors
• 2.开启新建仓库的Github Pages功能 (可选)
  • Setting -> Pages -> Build and deployment -> Source -> Github Actions

方式二: 使用GitHub Action

可以通过项目的 Marketplace Actions 界面选择已经发布的不同版本

action

- name: Thanks, Contributors!
  uses: Sunrisepeak/[email protected]

完整workflows示例 - .github/workflows/thanks-contributors.yml

name: Thanks, Contributors!

on:
  workflow_dispatch:
  schedule:
    - cron: "0 3 * * *"

permissions:
  contents: write

jobs:
  collect:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Collect contributors
        uses: Sunrisepeak/[email protected]

指定多个仓库或组织

      #...
      - name: Collect contributors
        uses: Sunrisepeak/[email protected]
        with:
            targets: 'Sunrisepeak/* d2learn/* mcpp-community/d2mcpp'

Caution

• 注1: 默认会统计当下用户或组织所有公开仓库的贡献者, 每天自动更新一次, 如果想只统计当前仓库或自定义统计的仓库可以查看 -> 参考文档

• 注2: 配置好后, 可以选择手动运行action或等定时触发后观察效果

• 注3: 如果需要切换自动提交为PR的方式, 参考 Q&A

示例

当前用户所有公开仓库的贡献者们 - 每天自动更新

贡献者图片墙

可以在 README.md 或 其他网站 引用生成的贡献者图片墙

![](.thanks-contributors/contributors.png)

可点击的贡献者Markdown列表

支持自定义文件路径, 以及自定义自动更新区域

Sunrisepeak	MoYingJi	wil1jiang	FrozenLemonTee	speak	2412322029	tiansongyu	sky-littlestar
521xueweihan	Ankali-Aylina	ExquisiteCore	13eholder	jwaiting	Mq-b	d2learn-org	zzxzzk115