GitHub仓库维护最佳实践及团队协作管控相关问题咨询

一、权限与文件范围管控方案 #

这部分可以直接实现你需要的强制权限规则、限定人员可编辑范围的需求，都是GitHub原生支持的功能，不需要额外接入第三方系统：

• 先配置成员基础权限：你作为维护人设为仓库管理员，4名内部开发设为写入权限，2名外聘顾问设为读取权限，所有人都不允许直接推送代码到受保护分支，所有代码变更必须走PR（拉取请求）流程提交。
• 开启main分支强制保护：在仓库设置的分支保护规则页，勾选以下规则：
  • 禁止任何人直接推送代码到main分支
  • 所有合并到main的PR必须至少1名审批人通过，把你自己设为强制审批人，所有PR必须你审批通过才能合并
  • PR必须没有合并冲突、必须通过你配置的基础检查（比如代码格式校验、单元测试跑通）才能合并
• 用CODEOWNERS文件限定可编辑范围：在仓库根目录新建名为CODEOWNERS的文件，按路径配置对应目录的审批负责人，示例写法：

  # 全仓库所有文件默认需要你审批
  * @你的GitHub账号名
  # 外聘顾问负责的业务目录，可配置仅对应顾问参与审批
  /modules/external-biz/ @顾问A账号 @顾问B账号
  # 核心配置、基础框架等敏感目录，仅你可以审批合入
  /config/ /framework/ @你的GitHub账号名
  

  配置后所有修改对应目录的PR，会自动要求对应负责人审批，没有审批通过的PR无法合并，自动实现不同人员的文件编辑范围限制。

二、合并冲突处理规范 #

按照以下流程操作可以大幅降低冲突出现概率，也能减少复杂冲突的处理成本：

• 前置冲突检查：要求所有成员提交PR前，必须先在本地拉取最新的main分支代码合并到自己的开发分支，本地解决完所有冲突后再提交PR，能避免90%的线上合并冲突。
• 复杂冲突处理规则：如果出现跨多人修改的复杂冲突，不要自行判断代码取舍，直接在PR里@所有修改过冲突文件的开发人员，要求他们确认各自代码的逻辑优先级，统一反馈后你再执行合并操作，避免误删有效代码。
• 定期分支同步：每周固定一个时间点（比如周一上班后）提醒所有成员同步本地main分支的最新代码，避免开发分支和main分支差异过大，累积出大量难以处理的冲突。

三、日常维护简化流程 #

6人团队不需要太复杂的流程，以下规则足够保证仓库稳定：

• PR提交统一要求：所有PR必须写明修改内容、影响范围、自测情况，不接受无描述的空PR，能大幅降低你的审核成本。
• 固定合入窗口：可以设定工作日上午10点、下午4点为固定的PR合并时间，其余时间只接收PR不执行合并，避免刚合入代码就出问题没人跟进处理。
• 外聘顾问代码额外校验：外聘顾问提交的PR除了审核逻辑正确性，还要额外检查是否有超出其负责范围的修改、是否夹带敏感配置信息，确认无误再合入。

内容的提问来源于stack exchange，提问作者Chuck