开发者

当你为 OpenStack 的一个组件编写新功能时，记录该新功能非常重要。如果你正在添加或更改配置选项、命令或其他用户界面组件，这一点也同样适用。

许多此类更改都可以通过 oslo.config 和 oslo.policy 等库提供的指令和配置生成器自动处理，并作为项目特定的文档发布。有关这些自动化工具的更多信息，请参阅 使用文档工具。

如果你正在向主 openstack-manuals 仓库贡献文档，你可以做一些事情来帮助你的补丁快速且轻松地合并

• 联系你的项目的文档 跨项目联络人。他们可以帮助你找到添加补丁的合适书籍，以及在你编写补丁后需要审查补丁的相关人员。

• 如果你对自己的书面英语技能没有信心，你可以创建一个补丁并添加说明，表示你乐于接受编辑协助。这将鼓励作者查看你的补丁并纠正任何拼写或语法错误，而不是仅仅添加评论供你自行修复。

• 如果你不知道应该编辑哪本书，或者不确定如何创建补丁，你可以创建一个包含源代码或注释的 bug，并向文档团队寻求帮助，以找到内容的正确位置。

• 如果你知道你想修改哪本书，请联系 合适的项目团队 或 子团队。他们可以帮助你确定内容应该放在哪里，并提供有关这些书籍架构即将发生的变化的详细信息，这些变化可能会影响你的新文档。

• 如果你打算进行非常大的更改，例如全新的章节或文档化一个新项目，核心团队可能会要求你创建一个蓝图和规范来描述该更改。如果你不确定你的更改是否需要蓝图或规范，请在邮件列表中寻求指导。

• 请记住，你可以始终通过我们的邮件列表或 IRC 联系文档团队。