Jump to content
CodeRelayHub

← All digest entries

让新工程师第一天就能与助手协作:七步配置指南

新工程师第一次打开仓库时,最需要的不是让助手立即生成代码,而是知道项目如何启动、哪些规则不能破坏,以及怎样证明修改正确。把这些信息变成可执行、可复现的配置,助手才能帮助新人建立判断,而不是放大陌生感。

1. 先定义第一天的完成标准

给新人安排一个边界清楚的小任务,例如修复输入校验,并补上一条回归测试。验收标准应包含:本地启动成功、相关测试通过、能够解释修改影响,以及提交一份便于审查的差异。

同时明确权限边界:助手可以读取哪些目录,执行安装或访问网络前是否需要确认,哪些操作必须由工程师亲自完成。生产部署、权限调整和数据库迁移,不应混进入职练习。

2. 配好入口,不共享身份

如果团队通过 CodeRelay Hub 统一接入,可以把 https://api.coderelayhub.com 记录为 API 基础地址,再按所用客户端的要求配置。不要假定 Claude Code、Codex、Gemini CLI 和 OpenAI SDK 使用相同的环境变量,也不要自行猜测是否需要追加路径。

为新人分配独立密钥,并按实际支持的能力限制权限和用量。密钥应放在团队认可的凭据存储或本地环境中;仓库只提交变量名与占位值。检查忽略规则,避免真实凭据进入提交历史。

3. 把启动流程变成一条可靠路径

在项目说明中固定运行时版本、依赖安装方式、启动命令和最小测试命令。存在锁文件时,沿用项目规定的安装流程,不让助手为了消除报错随意升级依赖。

准备不含真实客户信息的测试数据,并记录外部服务不可用时的替代方式。最好从干净工作目录验证一次:如果新人必须依赖某位同事电脑上的隐藏配置,环境就还没有准备好。

4. 给助手一份简短的仓库地图

先检查仓库是否已有助手指令文件,保留现有约定,再补充缺失内容。文件名和加载位置按客户端支持的机制设置;不能自动加载的说明,就在任务开始时明确提供。

  • 结构:标出入口、业务模块、测试目录和生成文件。
  • 约束:说明兼容性要求、禁止修改的区域和依赖变更规则。
  • 验证:列出格式检查、静态检查及相关测试命令。
  • 协作:要求先说明计划,遇到信息缺口先报告,不编造接口行为。

保持说明短而准确;设计背景可以指向仓库内的具体文件,避免复制成长篇、容易过期的规则集合。

5. 用只读任务验证助手是否真正就绪

第一次对话先不修改文件。请助手定位目标请求的入口、核心处理函数和现有测试,并用文件路径说明判断依据,再列出完成任务需要确认的问题。

让新人逐项核对这些路径。如果助手读错项目、找不到测试,或者把推测说成事实,先修复工作目录、访问权限或上下文。连接成功只证明请求能发出,不证明助手理解了仓库。

6. 用小补丁跑通完整交付流程

进入独立分支后,要求助手先给出最小修改方案,再实施局部变更。明确排除无关重构、批量格式化和顺手升级,避免第一个任务变成无法解释的大补丁。

修改后先运行相关测试,再按项目要求扩大验证范围。要求助手分别报告已经执行的命令、观察到的结果和未完成的检查;没有运行的测试,不能写成通过。新人还应亲自阅读差异,确认没有密钥、调试输出或无关文件。

7. 把一次成功整理成可重复的入职包

交付前保存经过验证的配置模板、仓库地图、首个练习和排错清单。排错顺序可以固定为:身份与余额状态、基础地址、客户端配置、网络连通性,最后才检查任务提示,减少反复改提示却找错方向。

后续即使切换模型,也沿用同一套验收任务和检查标准;不要把模型更换当作放宽审查的理由。入职包中保留维护负责人和验证日期,让下一位工程师接手的是可复现流程,而不是聊天记录。

打开免费工作区,开始搭建你的入职环境。

Try it on a real task: open a workspace and spend the trial credit.

Sign up