[ English | 한국어 (대한민국) | Indonesia | 中文 (简体, 中国) | español (México) | English (United Kingdom) | Deutsch ]

贡献者指南

什么是贡献者指南?

首先需要明确的是,我们讨论的不仅仅是代码项目。OpenStack 的贡献形式多样,例如举办见面会、识别用例(产品工作组)、文档编写、测试等。我们的目标是使这些贡献获得同等重视。

贡献者指南旨在为所有 OpenStack 贡献者提供通用文档,并协助入职工作。

由各个项目共同维护通用文档,将更好地帮助避免重复劳动、文档不一致,并提供更准确的信息。那些文档为零或过时的项目也可以直接使用贡献者指南。

指南的使用场景

在各种 OpenStack 活动中,贡献者指南被用于协助各种入职计划

项目特定的贡献者指南

项目团队仍然应该拥有自己的贡献者文档,以涵盖 非通用文档示例 下列出的内容。一些项目团队特定的贡献者指南示例包括 Nova 团队的文档团队的

添加/更新内容

在修改或添加新内容之前,请先熟悉 OpenStack 的代码/文档规范。您可以阅读 代码和文档贡献者指南 以了解入门信息。

阅读完指南后,使用 git 克隆贡献者指南仓库

git clone https://opendev.org/openstack/contributor-guide

内容规范

  • 不要出现大段文字。读者应该感觉可以在页面上完成事情,只需五分钟,而不是又打开了一个永远不会回来的遗忘标签页。

  • 使用截图。

  • 避免涵盖可能遇到的所有问题。具体情况将根据其普遍程度进行评估。

  • 请勿使用视频。它们太复杂,难以保持更新。

仅限通用内容

由于贡献者指南旨在通用,以便每个人都可以使用,因此以下是一些有用的贡献示例。不属于通用范畴的内容应在您的项目团队的特定文档中,这些文档将在贡献者门户中列出。

通用文档示例

  • 设置 Git。

  • 设置 IRC 进行通信。

  • 设置邮件列表进行通信。

  • 设置适当的帐户以进行贡献,例如 Gerrit、Storyboard 和 Launchpad。

  • 如何参与投票。

非通用文档示例

  • 仅您的项目团队使用的特定软件工具。

  • 进行诸如 bug 分类之类的特定流程。

优秀文档示例

使用已经接受的章节来了解我们正在寻找的内容。

我如何开始提供帮助?

错误报告和任务都记录在 Storyboard 中。如果某项内容未被分配,则您可以参与。

获取贡献帮助

我们希望您成功!您可以在 IRC OFTC 的 #openstack-doc 频道中寻求帮助。您也可以在 OpenStack Discuss 邮件列表 中寻求帮助,并在邮件主题前加上“[contributor-guide]”。如果您不熟悉这些通信方式,请阅读 代码和文档贡献者指南