如何为你的开源项目创建完美的 README

Hacktober 已经结束，但这并不意味着我们不应该继续鼓励大家为开源做出贡献。维护者吸引更多长期贡献者的方法之一是撰写优秀的 README。我做了一些研究，并整理了一份技巧清单，供您参考，帮助您撰写一份能够吸引贡献者加入社区的 README。

我为什么要创建 README？

为您的个人资料和组织创建 README 既有趣又重要。然而，为您的开源项目代码库撰写一份优秀的 README 也同样重要。您的 README 会给新用户和潜在贡献者留下对您项目的第一印象。需要明确的是，Contributing.md 文件允许贡献者在您的代码库中创建和合并拉取请求，而 README 则指导用户如何使用您的项目。

我应该在 README 中写些什么？

首先添加项目标题

此示例源自Open Sauced

添加一些简短的陈述，描述你的项目存在的原因以及它的作用

此示例源自Slinkity

告知用户如何安装和使用您的项目

此示例来源于Timber

让用户知道如何获得帮助

此示例来源于RasaHQ

包含重要文档的链接

此示例源自CodeNameOne

展示你的贡献者

此示例源自use-shopping-cart

添加项目许可证的链接

此示例来源于RasaHQ

更进一步，添加：

• 目录
  • （这是一份关于自动生成供您阅读的目录的文档）
• 该项目的技术栈和功能
• 指向您的生产实例的链接
• 项目用户界面的屏幕截图
• 依赖项
• 已知问题

我需要帮助让它看起来漂亮！

尝试使用Readme.so ，这是Katherine Peterson构建的一个开源项目，可以轻松构建和定制 README 的所有部分。

您还可以使用消费者金融保护局提供的此模板。

在下面评论您喜欢的项目自述文件或您创建的自述文件！