关于前端:如何为我们的开源项目创建完美的-README

作者：Rizel Scarlett
译者：前端小智
起源：dev

有幻想，有干货，微信搜寻 【大迁世界】 关注这个在凌晨还在刷碗的刷碗智。

本文 GitHub https://github.com/qq449245884/xiaozhi 已收录，有一线大厂面试残缺考点、材料以及我的系列文章。

咱们正在招聘，年薪：25-60万+奖金，有趣味的能够点我理解详情。

Hacktober 曾经完结了，但这并不象征激励程序员为开源做奉献的完结。维护者吸引更多长期贡献者的办法之一是写一个标准的 README。这里，参照一些风行的开源库中的 README 整顿了一份清单，让你创立一个能吸引贡献者退出你的社区的 README。

Hacktoberfest 是由出名云服务商 DigitalOcean 发动的一个推广、反对开源的年度在线流动，任何一个开源爱好者都能够参加。只有在10月份外向 GitHub 上的任意开源我的项目提交若干 Pull Request，就算实现流动工作，并将失去由 DigitalOcean、GitHub 等流动赞助商提供的纪念品。通常是限量版T恤、贴纸若干。

那么，Hacktoberfest 这个奇怪的名字是什么意思呢？这不是一个原生的英文单词，是由几个代表着这个流动的外围精力的单词缩写组合而成。其中的 Hacktober 是由 Hackathon（黑客马拉松） 和 October（十月） fest 则是 Festival（节日）的前几个字幕。看到这里，大家应该就明确了吧， Hacktoberfest 就是开源爱好者在每年的十月份通过做开源奉献的形式来流传、庆贺开源。

我为什么要写 README？

就像找工作要写个人简历一样，为本人的开源我的项目写一个优良的 README 同样重要。你README 能够为新用户和潜在贡献者提供了对咱们我的项目的第一印象。说白了，你的 Contributing.md 能够让贡献者在你的版本库中提出和合并拉动申请，而你的 README 则领导用户如何应用你的我的项目。

我应该在 README 中写些什么？

首先增加我的项目题目

这个例子来自 Open sauce。

增加一些简短的陈说，形容我的项目呈现起因和作用

这个例子来自Slinkity

告知用户如何装置和应用咱们的我的项目

这个例子来自Timber

让用户晓得如何取得帮忙

这个例子来自RasaHQ

包含重要文档的链接

这个例子来自CodeNameOne

展现你的贡献者

这个例子来自 use-shopping-cart

增加我的项目的许可证

这个例子来自 use-shopping-cart

能够附加一点

• 目录(这里有一个对于主动生成目录的文档)
• 我的项目的技术堆栈和性能
• 曾经在用的产品
• 我的项目的用户界面截图
• 依赖
• 已知的问题

怎么把它弄丑陋点

试试应用Readme.so，这是由Katherine Peterson建设的开源我的项目，能够轻松建设和定制README的所有局部。

~完，我是刷碗智，励志等退休后，要回家摆地摊的人，咱们下期见！

编辑中可能存在的bug没法实时晓得，预先为了解决这些bug,花了大量的工夫进行log 调试，这边顺便给大家举荐一个好用的BUG监控工具 Fundebug。

原文：https://dev.to/github/how-to-&＃8230;

交换

有幻想，有干货，微信搜寻 【大迁世界】 关注这个在凌晨还在刷碗的刷碗智。

本文 GitHub https://github.com/qq449245884/xiaozhi 已收录，有一线大厂面试残缺考点、材料以及我的系列文章。