Skip to content

贡献#

感谢您对贡献的兴趣!Autoware 受到像您这样的人的支持,并且欢迎各种类型和大小的贡献.

作为投稿人,以下是我们希望您遵循的 Autoware 及其相关存储库的准则.

与 Autoware 本身一样,这些指南正在积极制定中,并且始终欢迎提出改进建议!可以通过 在 Ideas 类别中创建讨论 来提出指南更改.

行为准则#

为确保 Autoware 社区保持开放和包容,请遵循 行为准则.

如果您认为社区中有人违反了行为准则,请发送电子邮件至 conduct@autoware.org 进行举报.

在开始之前,我应该了解什么?#

Autoware 概念#

为了大致了解 Autoware 的体系结构和设计,以下页面提供了简要概述:

对于经验丰富的开发人员,Autoware 接口单个组件页面 以更详细地了解每个组件或模块的输入和输出.

为开源项目做贡献#

如果您不熟悉开源项目,我们建议您阅读 GitHub 的 如何为开源做出贡献指南,了解人们为什么为开源项目做出贡献、贡献意味着什么等等.

我如何获得帮助?#

不要为一般支持问题打开问题,因为我们希望保留 GitHub 问题以报告已确认的错误.相反,请在 Q&A 类别中打开一个讨论.有关 Autoware 支持机制的更多详细信息,请参阅 支持指南 文件.

注意

维护者将针对问题或未确认的错误创建的问题移动到 GitHub 讨论区.

我该如何投稿?#

讨论#

您可以通过促进和参与讨论来为 Autoware 做出贡献,例如:

工作组#

Autoware Foundation 内的 各个工作组 负责实现技术指导委员会设定的目标.这些工作组对所有人开放,加入特定的工作组将使您了解当前项目,了解每个组内如何管理这些项目,并为有助于推进特定项目的问题做出贡献.

要查看即将召开的工作组会议的时间表,请参阅 Autoware Foundation 活动日历.

Bug 报告#

在报告错误之前,请在问题跟踪器中搜索相应的存储库.可能有人已经报告了相同的问题,并且存在解决方法.如果您无法确定合适的仓库,请在 Q&A category 中创建新讨论,向维护者寻求帮助.

报告错误时,您应该提供一组最少的说明来重现问题.这样做使我们能够快速确认并专注于正确的问题.

如果您想自己修复错误,我们将不胜感激,但您应该在提交拉取请求之前与问题中的维护者讨论可能的方法.

创建问题很简单,但如果您碰巧遇到任何问题,请创建一个 Q&A 讨论以寻求帮助.

拉取请求#

您可以提交小更改的拉取请求,例如:

  • 次要文档更新
  • 修复拼写错误
  • 修复 CI 故障
  • 修复编译器或分析工具检测到的警告
  • 对单个包进行小改动

如果您的拉取请求是一个较大的更改,则应遵循以程:

  1. 创建 GitHub 讨论 提出更改.这样做可以让您从其他成员和 Autoware 维护者那里获得反馈,并确保提议的更改符合 Autoware 的设计理念和当前的开发计划.如果您不确定在哪里进行对话,请 创建新的 Q&A 讨论.

  2. 创建问题 在讨论中达成共识

  3. Create a pull request 实施引用在第 2 步中创建的 Issue 的更改

  4. 为新添加的内容创建文档(如果相关)

大型更改的示例包括:

  • 向 Autoware 添加新功能
  • 添加新的文档页面或部分

有关如何提交良好拉取请求的更多信息,请阅读 拉取请求指南,不要忘记查看所需的 许可证符号