跳到内容

贡献者指南

欢迎来到 PROJECTNAME 贡献者指南!

如果您的项目没有文档网站(如果它非常简单,文档网站会显得过分),以下信息应该出现在项目的 CONTRIBUTING.md 文件中,并且从 README 模板 中引用。

在以下部分中,如果内容很简单,只需几行,请将其包含在该部分中。否则,请创建单独的文件,并从该部分中引用它们。如果需要,请添加其他部分。

项目在 Ansible 生态系统中的位置

在此处描述项目在 Ansible 生态系统中的位置。例如,该项目可以是另一个项目的组件,或者作为辅助项目。如果该项目是一个独立的、自包含的工具,则可以省略此部分。

非代码贡献

提出和回答问题

提出和回答问题。与您的用户和贡献者联系和沟通。在 社区指南 中查看官方沟通渠道。

贡献文档

审查、修复和维护文档是为 PROJECTNAME 做出贡献的好方法。

描述如何为文档做出贡献或列出对单独文档指南的引用。提供指向带有文档相关标签的问题的 GitHub 链接。

如何打开问题

如果您想报告错误或请求新功能

  1. 问题 中搜索类似的报告/请求。
  2. 如果尚未出现此类问题,请单击 新建问题 按钮打开一个新问题。

代码贡献

考虑使用单独的代码贡献者指南,并在此处提供指向该指南的链接。

项目架构

在此处描述项目的架构:其组件以及它们如何协同工作。

入门

使用 good first issue 标签标记易于修复的新手问题。

如果您没有特定的贡献想法,请查看 good first issues

创建一个简单且一致的入门开发指南,其中包含所有需要知道的信息,以便从分叉存储库并设置开发环境到运行测试并提交拉取请求,才能做出自己的首次贡献。请查看 创建第一个集合拉取请求 指南作为示例。

测试

描述项目中测试的工作原理,以及如何在本地添加各种测试并运行它们。

审查开放问题和拉取请求

审查开放问题和拉取请求是为 PROJECTNAME 做出贡献的好方法。即使您没有编码经验,您也可以从用户的角度分享您对所请求的功能/其实现的意见。

描述如何审查问题/PR。如果您有提交者指南/审查清单,请将其列出在此处(请查看 示例)。