知识卡片
README是入口
搭建指南几乎是每个代码库的必做工作,最好以 README 形式放在代码里,开发者复制代码到本地就能看到,并随项目演进持续更新。好的指南应像 GitHub 上的开源项目一样,说明必要的依赖准备和搭建方式、线上示例或运行环境、相关文档等。发散:README 不必解释整个系统,而是让新人第一次拉代码时少撞墙。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
原书出处
参考来源
- 位置:《前端架构:从入门到微前端》第3章《架构基础:工作流设计》(源文件:_epub-src/OEBPS/Text/0006.xhtml)
- 结论依据:原文说明搭建指南几乎是每个代码库的必做工作,最好以 README 形式存在于代码中并持续更新;好的指南应像开源项目那样说明依赖准备与搭建、线上示例等。
- 原始内容:它最好能以某种形式存在于项目的代码中,如README,开发人员在复制代码到本地时,就可以直接查看。……并且在项目演进的过程中,持续不断地对它进行更新,以便其他人能顺利地开展活动。