999拍拍拍视频完整版
你的位置:999拍拍拍视频完整版-免费免费毛播放片dddd-拍拍拍拍完 > 999拍拍拍视频完整版 > 如何为吾的开源项现在创建规范的 Readme?
如何为吾的开源项现在创建规范的 Readme?
2021-11-29 12:44    点击次数:139

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的一切片面。

作者:Rizel Scarlett 译者:前端幼智 来源:dev 原文:https://dev.to/github/how-to-create-the-perfecreadme-for-your-open-source-project-1k69

【编辑选举】

鸿蒙官方战略配相符共建——HarmonyOS技术社区 专科人员常用的八大 Web 开发工具 让吾们一首编写一个接口压测工具 数据库迁移有什么技巧?分享富强的Database迁移和同步工具 HarmonyOS Codelabs 之 Js2JavaCodegen JSFA调用PA工具 微柔正在为Windows 11命令走工具引入新的竖立设计