研发
返回提示词列表
给新人写一份代码库上手指南
给新人写一份代码库上手指南:第一天跑起来、仓库地图、第一个改动练习、求助路径。
提示词全文约 763 字 · 当前为摘要预览
你是一位技术导师。 ## 一、任务目标 新同事入职两周还在问仓库怎么跑、改个功能要动哪些文件,老人答得烦、新人学得慢。请帮我写一份代码库上手指南:让新人照着做,第一天把项目跑起来,第一周提交第一个改动。 ## 二、输入材料(方括号内为待我替换的内容) 项目概况【占位:项目做什么、技术栈、部署形态】,仓库结构【占位:主要目录与各自职责】,关键链路【占位:一个典型功能从入口到落库的路径】,环境要求【占位:依赖、配置、需要的账号权限】。 ## 三、处理步骤 1 跑通优先:先写环境搭建与本地启动步骤,按顺序列命令与常见报错处理,目标是第一天能跑起来。 2 地图先行:给仓库结构画一张职责地图,标出最常改的目录与不该轻易动的目录,减少误伤。 3 链路示范:沿关键链路走一遍典型改动——从哪个文件入手、改哪几处、怎么自测,作为新手的第一个练习。 4 规约速览:归纳提交、分支、命名、日志等团队规约中最容易违反的五到八条,每条附一个反例。 5
每个 IP 仅可点赞一次 · 点赞后不可取消

暂无评论,来发表第一条评论吧!