#103·realworld

为完成的仓库标准化 README

作者: EricSimons创建于 2017年5月5日更新于 2022年1月1日
标签Status: RFCv2 changelog

对于那些刚刚进入示例仓库并不知道 RealWorld 是什么的人来说,我想他们会想 "呃, 这到底是什么?". 例如, 后端代码库没有提到如何获取示例前端的设置和运行(更不用说如何选择前端了)。这很容易通过在每个 README 的顶部添加一个标准的"这是什么?"部分来解决。此外, 如果有关于常见主题的标准部分, 例如"安装依赖项","运行应用程序","架构概述"等, 那么人们通常会去寻找这些信息。这绝对是改进仓库浏览/探索用户体验的一个关键因素。

内容来源: realworld-apps/realworld