开源项目贡献者_创建开源贡献者准则的模板

最新推荐文章于 2024-05-08 09:46:23 发布

cumo7370

最新推荐文章于 2024-05-08 09:46:23 发布

阅读量234

点赞数

文章标签： java python 数据库 github linux

原文链接：https://opensource.com/life/16/3/contributor-guidelines-template-and-tips

版权

开源项目贡献者

开源项目可以提供给潜在贡献者的最重要资源之一就是贡献者指南。当渴望新的贡献者赶赴您的项目进行首次开源贡献时，他们将依靠您的贡献者指南作为指导手。这意味着贡献者指南应该易于阅读，透彻且友好。

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

阅读您的贡献者指南的大多数人从未为您的项目做出过贡献。因此， 您的指南应针对新的贡献者 。
认识到读者将为开放源代码项目做出贡献这一事实，这可不是一件容易的事。 让读者知道，项目的维护者，其他贡献者和用户对此表示赞赏。 这可以作为新贡献者的动力。
确保您的贡献者准则很完整。 不要害怕重复您认为多余的信息。是的，在线上有很多资源可以解释如何克隆存储库或如何提交拉取请求，但是新的贡献者可能不知道这一点。确保您的贡献者指南是有关如何与项目进行交互的权威资源。
在贡献者准则中保持轻松友好的语气 。开个玩笑。包括一些双关语。新的贡献者对为项目做出贡献感到不安，而您的贡献准则中的活泼基调可以帮助减轻这种负担。
对于维护者来说， 标记和标记问题可能是一个繁琐的过程，但是对于项目的新贡献者和用户而言，这确实是一个奇迹。表示特定问题所属类别的标签（设计，文档，前端，后端等），与特定问题相关的工作量级别以及与特定问题相关的优先级。

贡献者准则模板

我需要知道什么来帮助您？

如果您希望帮助进行代码贡献，那么我们的项目将使用[插入项目所使用的编程语言，框架或工具列表] 。如果您还不愿意贡献代码，那就没问题了！您还可以签出文档问题[链接到问题跟踪器上的docs标签或标签]或我们拥有的设计问题[如果项目跟踪设计问题，则链接到问题跟踪器上的设计标签或标签] 。

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

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

我该如何捐款？

从来没有做过开源贡献？想知道贡献在我们的项目中如何工作？这是一个快速的总结！

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