创建开源贡献者指南的模板

图片来源：

Nasjonalbiblioteket。由 Opensource.com 修改。CC BY-SA 4.0

开源项目可以为潜在贡献者提供的最重要的资源之一是贡献者指南。当渴望的新贡献者涌入您的项目以做出他们的第一个开源贡献时，他们依靠您的贡献者指南作为他们的指导。这意味着贡献者指南应该易于阅读、全面且友好。

您将在下面找到特定 git 工作流程的贡献者指南模板。如果您有兴趣开发自己的指南，这里有一些提示和技巧

大多数阅读您的贡献者指南的人从未为您的项目做出贡献。因此，您的指南应针对新的贡献者。
认识到读者即将为开源项目做出贡献这一事实，这绝非易事。让读者知道项目的维护者、其他贡献者和用户感谢这项努力。 这可以作为新贡献者的动力。
确保您的贡献者指南全面。 不要害怕重复您可能认为冗余的信息。是的，网上有很多资源解释如何克隆存储库或如何提交拉取请求，但新的贡献者可能不知道这一点。确保您的贡献者指南是关于如何与项目交互的权威资源。
在您的贡献者指南中保持轻松友好的语气。开几个玩笑。包含一些双关语。新的贡献者对为项目做出贡献感到紧张，而贡献指南中轻松愉快的语气可以帮助缓解这种情况。
标记和标记问题对于维护者来说可能是一个繁琐的过程，但它对新的贡献者和项目用户来说非常有用。标记表示特定问题所属的类别（设计、文档、前端、后端等）、与特定问题相关的努力程度以及与特定问题相关的优先级。

贡献者指南模板

我需要了解什么才能提供帮助？

如果您希望通过代码贡献来提供帮助，我们的项目使用[插入您的项目使用的编程语言、框架或工具列表]。如果您觉得还没有准备好做出代码贡献，没问题！您还可以查看文档问题[链接到您的issue tracker上的docs标签或标记]或我们拥有的设计问题[如果您的项目跟踪设计问题，则链接到issue tracker上的design标签或标记]。

如果您有兴趣做出代码贡献并想了解更多关于我们使用的技术，请查看下面的列表。

包括项目符号列表
新贡献者的资源（教程、视频、书籍）
可以用来学习他们需要知道什么才能为您的项目做出贡献

我如何做出贡献？

以前从未做出过开源贡献？想知道在我们的项目中贡献是如何运作的？这是一个快速概述！

找到您感兴趣解决的问题或您想添加的功能。
将与问题关联的存储库 Fork 到您的本地 GitHub 组织。这意味着您将在 您的 GitHub 用户名/存储库名称 下拥有存储库的副本。
使用 git clone https://github.com/github-username/repository-name.git 将存储库克隆到您的本地计算机。
使用 git checkout -b branch-name-here 为您的修复创建一个新分支。
为您尝试解决的问题或您想要添加的功能进行适当的更改。
使用 git add insert-paths-of-changed-files-here 将更改文件的文件内容添加到 git 用于管理项目状态的“快照”，也称为索引。
使用 git commit -m "在此处插入对所做更改的简短消息" 存储索引的内容并附带描述性消息。
使用 git push origin branch-name-here 将更改推送到远程存储库。
向 upstream 存储库提交拉取请求。
使用对所做更改的简短描述以及与您的更改关联的问题或错误编号来命名拉取请求。例如，您可以像这样命名一个问题“添加了更多日志输出以解决 #4352”。
在拉取请求的描述中，解释您所做的更改、您认为拉取请求存在的任何问题以及您对维护者的任何疑问。即使您的拉取请求不完美也没关系（没有拉取请求是完美的），审阅者将能够帮助您解决任何问题并改进它！
等待维护者审查拉取请求。
如果审查维护者建议，请对拉取请求进行更改。
在您的拉取请求合并后庆祝您的成功！