微信搜索【GreatMovetotheWorld】，第一时间与大家分享前端行业动态、学习路径等。本文已收录到GitHubhttps://github.com/qq449245884/xiaozhi，里面有完整的测试站点、资料和我的一线厂商访谈系列文章。Hacktober结束了，但这并不意味着鼓励程序员为开源做出贡献的结束。维护者吸引更多长期贡献者的方法之一是编写规范的自述文件。在这里，我们从一些流行的开源库中编制了一份README清单，使您可以创建一个README来吸引贡献者加入您的社区。Hacktoberfest是知名云服务商DigitalOcean为推广和支持开源而发起的一年一度的线上活动，任何开源爱好者都可以参与。只要在10月内向GitHub上的任何一个开源项目提交几个PullRequest，就可以完成活动任务，并获得DigitalOcean和GitHub等活动赞助商提供的纪念品。通常是限量版T恤和贴纸。那么，Hacktoberfest这个奇怪的名字是什么意思呢？这不是一个地道的英文单词，而是几个缩写词的组合，代表了这项活动的核心精神。其中，Hacktober由Hackathon（黑客马拉松）和October（十月）fest组成，是Festival（节日）的前几个副标题。看到这里大家应该明白，Hacktoberfest是开源爱好者通过每年十月做出开源贡献来传播和庆祝开源的。我为什么要写README？就像求职时写简历一样，为你的开源项目写一个优秀的README同样重要。您的自述文件给新用户和潜在贡献者对我们项目的第一印象。坦率地说，您的Contributing.md允许贡献者在您的存储库中创建和合并拉取请求，而您的README告诉用户如何使用您的项目。我应该在README中写什么？先添加项目标题本例来自Opensauce。添加一些简短的陈述来描述项目的原因和作用。这个来自Slinkity的例子告诉用户如何安装和使用我们的项目。这个例子来自Timber，让用户知道如何获得帮助。此示例来自RasaHQ，并包含指向重要文档的链接。这个例子来自CodeNameOne向你展示贡献者这个例子来自use-shopping-cart添加项目的许可证这个例子来自use-shopping-cart你可以附加一个小目录（这里有一个关于自动生成目录的文档）项目的技术栈和特性已在使用的产品项目用户界面的屏幕截图依赖项已知问题如何使它漂亮尝试使用Readme.so，这是一个由KatherinePeterson开发的开源项目，可以轻松构建和自定义README的所有部分。~最后，我是碗志、李志等，退休后想回家摆地摊。下次见！编辑过程中可能存在的BUG无法实时获知。之后为了解决这些bug，花费了大量的时间在日志调试上。顺便推荐一个好用的BUG监控工具Fundebug。原文：https://dev.to/github/how-to-...交流有梦想，有干货，微信搜索【大招天下】关注这位还在洗碗的洗碗大智慧清晨。本文GitHubhttps://github.com/qq44924588...已收录，有完整的测试站点、资料和我的一线厂商访谈系列文章。
