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

介绍和目标

什么是贡献者指南?

首先,重要的是要注意我们不只是谈论代码项目。 OpenStack贡献有不同的形式,例如举办聚会、识别用例(产品工作组)、文档、测试等等。我们的目标是使这些贡献具有同等价值。

“贡献者指南”旨在为所有OpenStack贡献者提供通用文档,并帮助进行入门工作。

通过各种项目整理的通用文档将更好地帮助防止重复工作及不一致的文档,并且还将提供更准确的信息。 没有文档或者文档过时的项目也可以使用“贡献者指南”。

使用指南的地方

在各种OpenStack活动中,“贡献者指南”用于帮助各种入门计划:

特定项目的贡献者指南

Project teams should still have their own contributor documentation to cover things listed under Examples of Documentation that’s NOT Common. A couple examples of project team specific contributor guides are the Nova team’s and the Documentation team’s.

添加/更新内容

在修改或添加新内容之前,首先要熟悉OpenStack的代码/文档实践。 您可以阅读 代码与文档贡献者指南 以便入门。

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

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

内容指南

  • 不要长篇大论。如果能在5分钟看完页面,那么读者会感觉良好,否则只会关掉页面,再也不会回顾。

  • 使用屏幕截图。

  • Avoid covering every issue that can be hit along the way. Case by case basis will be accepted depending on how common it is.

  • 请不要使用视频。 它们太复杂而无法保持更新。

仅限通用内容

As the Contributor Guide is meant to be general so everyone can use it, here are some helpful examples of what should be contributed. Examples of things that are not common should be in your project team’s specific documentation which will be listed in the Contributor Portal.

通用文档的示例

  • 设置Git。

  • 设置IRC进行通信。

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

  • 设置适当的帐户以贡献Gerrit,Storyboard和Launchpad。

  • 如何在选举中投票。

不通用的文档示例

  • 只有您的项目团队使用的一些特定的软件工具。

  • 做某事的具体过程(如处理bug分类)。

好文档的示例

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

我该如何开始帮助?

bug报告和任务都记录在 Storyboard 中。 如果某些任务没有分配出去,那么你可以领取。

获取帮助

我们希望你成功! 你可以在 IRC Freenode 的 #openstack-doc 频道中寻求帮助。你也可以在 OpenStack讨论邮件列表 上寻求帮助,请给你的电子邮件主题添加前缀“[contributor-guide]”。如果你不熟悉这些沟通方式,请阅读 代码与文档贡献者指南.