Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ The first command installs the kit (public raw URL, no login required); the seco

> Prerequisite: the agent must be authenticated to GitHub (able to push branches / open PRs). Identity emails must be real, GitHub-recognized agent/bot identities; forging is forbidden.

### Let your agent do it

Do not want to type the commands yourself? Just tell any agent session (Codex / Claude Code / Gemini CLI / Cursor):

> Use https://github.com/academic-door/github-multiagent-contributor to add codex, claude and renovate as contributors to `<target repository>`.

The agent will: download the kit → `--apply` to create a branch with trailers → push the branch → open a PR. You only confirm before the merge.

## Identity catalog

[contributor-catalog.md](docs/contributor-catalog.md) lists two **verified** identity classes (35 in total):
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ python scripts/build_contributors.py --apply --tools codex,claude,renovate

> 前提:Agent 已认证 GitHub(可推送分支 / 开 PR)。身份邮箱必须是 GitHub 能识别的真实 Agent / Bot 身份,禁止伪造。

### 交给你的 Agent 去实现

不想自己敲命令?在任意 Agent 会话(Codex / Claude Code / Gemini CLI / Cursor)里直接说:

> 用 https://github.com/academic-door/github-multiagent-contributor 这套方案,给 `<目标仓库>` 加 codex、claude、renovate 作为 contributor。

Agent 会自行完成:下载套件 → `--apply` 建分支并写入尾注 → 推送分支 → 打开 PR。你只需在合并前确认。

## 身份目录

[contributor-catalog.md](docs/contributor-catalog.md) 收录两类**已验证**身份(共 35 个):
Expand Down
4 changes: 3 additions & 1 deletion docs/contributor-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
曾经测试的 B 组(Gemini/Copilot 的 noreply 邮箱、ChatGPT、Aider、Cline、Cursor、Windsurf)
已实测不会进入页面,故从本目录移除。

> 快速安装:`bash <(curl -fsSL https://raw.githubusercontent.com/academic-door/github-multiagent-contributor/main/scripts/fetch-kit.sh)`
>
> 透明披露:共同作者尾注只用于署名归因,不代表对应工具真实参与了每一个提交;
> 本仓库把它当作“归因记录”功能使用,与 `activity/agent-checkins.csv` 配套。

Expand Down Expand Up @@ -96,7 +98,7 @@ python scripts/build_contributors.py --bots --commit-message "feat: example"

## 迁移到其他仓库(三步)

1. 复制本目录的 `docs/contributor-catalog.md` 和 `scripts/build_contributors.py` 到目标仓库。
1. 一键安装套件(见顶部命令),或手动复制本目录的 `docs/contributor-catalog.md` 与 `scripts/build_contributors.py` 到目标仓库。
2. 用 `build_contributors.py` 选择要添加的身份(A 组或 C 组),把尾注写进提交信息并合并进默认分支。
3. 刷新目标仓库 Contributors 页面,核对出现哪些身份。

Expand Down
16 changes: 8 additions & 8 deletions docs/scheduled-agent-checkin.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@
| 变量 | 值 |
| --- | --- |
| `AGENT_CHECKIN_ENABLED` | `true` |
| `AGENT_CHECKIN_AUTHORS` | `Codex <[email protected]>;Claude <[email protected]>` |
| `AGENT_CHECKIN_AUTHORS` | `Codex <[email protected]>;Claude <[email protected]>;...` |

可选维护者提交变量:
- 本仓库默认身份为 Codex、Claude 与两位维护者;**其他仓库请把 `AGENT_CHECKIN_AUTHORS` 设为你们自己的身份组合**(英文分号分隔,可含 `[bot]` 名字)。
- 可选维护者提交变量:`GIT_AUTHOR_NAME`(默认 `github-actions[bot]`)、`GIT_AUTHOR_EMAIL`(默认 `41898282+github-actions[bot]@users.noreply.github.com`)。

| 变量 | 默认值 |
| --- | --- |
| `GIT_AUTHOR_NAME` | `github-actions[bot]` |
| `GIT_AUTHOR_EMAIL` | `41898282+github-actions[bot]@users.noreply.github.com` |
## 运行方式

工作流默认每天北京时间 08:17 运行,也可以在 Actions 页面手动运行。它会检查当天是否已有记录,每天最多生成一个提交。
- 每天 **00:17**(Asia/Shanghai)定时运行,另设 **08:17** 兜底(GitHub 定时偶发跳跑);实际提交通常约 01:15 落盘。
- 也可在 Actions 页面手动 **Run workflow**。
- CSV 按日期去重:每天最多生成一条记录、一个提交;补跑不会重复。

## 分支保护前提

Expand All @@ -32,7 +32,7 @@

## 署名边界

`AGENT_CHECKIN_AUTHORS` 只应填写真实、已注册且允许用于署名的 Agent 身份。默认值是已验证的 Codex 和 Claude 地址。自动 check-in 是透明的连续性记录,不应描述为 Agent 当天完成了代码、研究或审查。真实任务仍应通过 Issue、分支、PR、CI 和 Review 记录。
`AGENT_CHECKIN_AUTHORS` 只应填写真实、已注册且允许用于署名的 Agent / Bot 身份;不要伪造邮箱。自动 check-in 是透明的连续性记录,不应描述为 Agent 当天完成了代码、研究或审查。真实任务仍应通过 Issue、分支、PR、CI 和 Review 记录。

## 关闭

Expand Down
11 changes: 6 additions & 5 deletions docs/verification-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- 验证时间:2026-08-03 ~ 2026-08-04
- 验证仓库:https://github.com/academic-door/github-multiagent-contributor
- 最终结果:Contributors 页面 **42 个身份**
- 最终结果:Contributors 页面 **42 个身份**(截至 2026-08-04 实测;每日 check-in 会持续累计贡献次数)

## 1. 机制原理

Expand Down Expand Up @@ -57,7 +57,8 @@ GitHub 会解析进入默认分支的提交中的 `Co-Authored-By: Name <email>`

## 5. 迁移到其他仓库(快速版)

1. 复制 `docs/contributor-catalog.md`、`scripts/build_contributors.py`(可选 `.github/workflows/scheduled-agent-checkin.yml`)。
2. 选择身份:`python scripts/build_contributors.py --tools codex,renovate,snyk` 或 `--bots`。
3. 把生成的尾注追加到提交信息,合并进默认分支;刷新 Contributors 页面核对。
4. 想每日自动:设 `AGENT_CHECKIN_ENABLED=true` 与 `AGENT_CHECKIN_AUTHORS`(自己的身份组合)。
1. **一键安装**:`bash <(curl -fsSL https://raw.githubusercontent.com/academic-door/github-multiagent-contributor/main/scripts/fetch-kit.sh)`(自动下载 `build_contributors.py` 与 `docs/`)。
2. **选择身份**:`python scripts/build_contributors.py --tools codex,renovate,snyk` 或 `--bots`;自助建分支+提交用 `--apply --tools ...`。
3. 合并进默认分支,刷新 Contributors 页面核对。
4. **想每日自动**:设 `AGENT_CHECKIN_ENABLED=true` 与 `AGENT_CHECKIN_AUTHORS`(自己的身份组合)。
5. **移除 / 验证**:`--remove --tools renovate`、`--check --tools codex`。