工程入口、文档与交付规范
Git、代码规范与项目工程化#Python全栈#第六阶段#Git、代码规范与项目工程化#工程入口、文档与交付规范约 645 字 · 2 分钟阅读
追问显示点击任意追问卡片可收起 / 展开
一个可交接项目的 README 应包含哪些内容？
追问 新成员如何仅凭文档完成环境准备、安装、运行和基本检查？怎样验证文档没有遗漏步骤？
为什么项目应提供统一的格式化、检查和运行入口？
追问 脚本、任务工具或 Makefile 各适合什么场景？如何避免入口依赖某个人机器上的绝对路径？
提交前自动检查适合做什么，不能保证什么？
追问 本地钩子可能被跳过或未安装时，团队还需要哪些共享检查？怎样控制检查耗时？
基础自动检查流程应该验证哪些项目能力？
追问 依赖安装、静态检查、测试与构建分别能发现哪些问题？检查失败时怎样提供可定位的信息？
同一提交在本地和自动检查环境表现不同，应该比较哪些条件？
追问 解释器、依赖、工作目录、环境变量、时区和操作系统怎样影响结果？
测试或构建产物为什么通常不直接提交进源代码仓库？
追问 什么情况下确实需要保存生成文件？应如何说明生成方式和保证它与源文件同步？
版本号和变更记录应如何帮助使用者判断升级影响？
追问 新增功能、缺陷修复和不兼容变化怎样表达？为什么不能仅凭版本号保证没有回归？
修改供其他模块使用的函数接口时，应如何评估兼容性？
追问 参数名称、默认值、返回结构和异常类型分别可能影响哪些调用方？如何安排过渡？
如何让交付文件与某个确定的 Git 提交对应起来？
追问 版本标签、提交哈希、构建记录与文件校验值分别提供什么证据？工作区未提交修改如何影响判断？
交接一个暂时无法完成的功能，应该留下哪些信息？
追问 当前进度、复现步骤、已知限制、依赖事项与下一步建议，怎样写得让接手者能够继续？