外部贡献者接入指南

🔀 用 Fork + Pull Request 提交你的贡献

适用于各部门想提修复、优化,或贡献代码/整个架构专案的伙伴——不用等核心团队帮你改,自己 fork 一份提交就行。

你是核心团队(温蒂/艾拉/金金/林晨风)?请改看 《核心团队接入指南》。
整体原理:这些仓库是私有仓,你不会拿到直接推送(push)的权限——你只能 Fork(复制一份到你自己的 GitHub 帐号)、在自己的副本上改,改完开 Pull Request(PR) 请核心团队审查、合并。这样你能自由改,核心团队也能在合并前把关。
全流程 6 步:① Fork 仓库 → ② Clone + 建分支 → ③ 改代码 + 自己测试 → ④ 开 Pull Request → ⑤ 等待审查 → ⑥ 合并,由核心团队部署上线
1

Fork 仓库到你自己的帐号

打开你要贡献的仓库页面,右上角点 Fork,GitHub 会复制一份到你自己的帐号下。你在自己这份副本里想怎么改都不会影响正式版本。

目前开放贡献的试点仓库:

反馈闭环github.com/kefucenterteam/csc-feedback-loop
目标分支:master
离席打卡机器人github.com/kefucenterteam/csc-awaytimer_bot
目标分支:main
💡 如果你还没有这些仓库的存取权限(连 Fork 按钮都看不到),先联络艾拉或温蒂,请她们把你加为该仓的协作者(Read 权限)。
2

Clone 自己的 fork,建一个新分支

git clone https://github.com/你的帐号/仓库名.git
cd 仓库名
git checkout -b fix/我的修复描述
🔴 先设好提交署名(只要设一次):面板是按你的 GitHub 账号把贡献记到你头上的,署名不对就会记到别人或认不出是谁。在终端跑(换成你自己的 GitHub 用户名):
git config --global user.name "你的GitHub用户名"
git config --global user.email "你的GitHub用户名@users.noreply.github.com"
邮箱也可以用已经在 GitHub 验证过的邮箱。别在单一仓库里另外设署名,那会盖过上面这个设定。第一次贡献前,也请把你的 GitHub 用户名和花名告诉艾拉,让面板把账号对到你。
3

改代码,自己先测过

改完记得跑一遍这个仓库既有的测试(若有),确认没弄坏原本的功能,再 commit、push 到你的 fork:

git add 你改的档案
git commit -m "说明这次改了什么"
git push origin fix/我的修复描述
4

开 Pull Request

Push 完,GitHub 网页上会跳出「Compare & pull request」提示,点下去、确认目标分支选对(上面步骤①有列每个仓的正确分支),写清楚这次改了什么、为什麽改,就可以送出。

⚠️ 这些档案改动大概率会被打回,除非你的修复真的必须动到:
  • 部署脚本、系统设定档、凭证(.env 相关)
  • 核心权限验证、资料库结构
各仓库 .github/CODEOWNERS 有列出具体清单,PR 若碰到这些档案,请在说明里讲清楚原因。
5

等待审查

核心团队会审查你的改动,通常几天内会回覆。改动越小、说明越清楚,审得越快。

✅ 通过审查会直接帮你合并,你会在 GitHub 收到通知邮件/站内信。
6

合并,由核心团队部署上线

合并完成后你的贡献就正式进了这个专案;合并不等于已经上线——上线由核心团队安排部署(服务器一律从 GitHub 拉取这一版,你不需要、也不会拿到服务器账号),上线后会通知你。你的贡献会显示在面板的「专案进度总览」与「每日进度」里,标上 🔀 外部贡献 徽章。你的 fork 之后还能继续用来提交下一次贡献,不用重新 fork。

常见问题

我没有这个仓库的写入权限,能提交吗?
可以,Fork 之后你是在自己的副本上改,不需要原仓库的写入权限,只需要能看到仓库(Read 权限)就能 Fork。
PR 被打回了怎么办?
看审查留言,通常是建议拆分改动或说明理由,改完重新 push 到同一个分支即可,PR 会自动更新,不用重开一个新的。
我想贡献一整个新专案,不只是小修复,怎么办?
先联络艾拉或温蒂讨论落地方式(新仓库/挂进现有系统),流程上一样是走 Fork + PR,只是规模比较大,建议先对齐架构方向再动手。