支持指南#
本页介绍了我们提供的支持机制.
警告
在寻求帮助之前,请仔细搜索并阅读此文档站点. 另外,请遵循讨论指南 进行讨论.
根据您需要的帮助类型选择合适的资源,并阅读以下部分中的详细说明.
Autoware 社区支持指南#
如果您在使用 Autoware 时遇到问题,请按照以下步骤寻求帮助:
1.搜索现有 Issue 和 Questions#
在创建新问题或疑问之前,请检查是否有其他人已经报告或询问了该问题.使用以下资源:
请注意,Autoware 在 autoware.repos 中列出了多个仓库. 建议在所有存储库中搜索.
2.创建新的问题线程#
如果您找不到解决您问题的现有问题或问题,请创建一个新的问题线程:
如果你的问题在一周内没有得到解答,请在帖子中提及 @autoware-maintainers 来提醒他们.
3.参与其他讨论#
也欢迎您打开或加入其他类别的讨论:
其他资源#
如果您不确定如何创建讨论,请参阅 关于创建新讨论的 GitHub 文档.
文档站点#
文档指南 显示了有用的文档站点列表. 访问他们,看看是否有任何与您的问题相关的信息.
请注意,文档站点并不总是最新和完美的. 如果您发现 Autoware 文档中的某些信息错误、不清楚或缺失,请随时按照 贡献指南.
GitHub 讨论#
GitHub 讨论页面 是提出问题和讨论与 Autoware 相关的主题的主要位置.
| 分类 | 描述 |
|---|---|
| 公告 | 来自 Autoware 维护人员的官方更新和新闻 |
| 设计 | 关于 Autoware 系统和软件设计的讨论 |
| 功能请求 | 新功能和改进建议 |
| 常规 | 关于 Autoware 的一般讨论 |
| 想法 | 集思广益,分享创新理念 |
| 民意调查 | 社区民意调查和调查 |
| Q&A | 来自社区和开发人员的问题和解答 |
| 展示和讲述 | 项目和成就展示 |
| TSC 会议 | TSC(技术指导委员会)会议纪要和讨论 |
| 工作组活动 | 工作组活动更新 |
| 工作组会议 | 工作组会议记录和讨论 |
警告
GitHub Discussions 不是跟踪任务或 bug 的合适位置.为此,请使用 GitHub Issues.
GitHub 问题#
GitHub Issues 是用于跟踪 Autoware 各种存储库中已确认的错误、任务和增强功能的指定平台.
请遵循以下准则,以确保有效地跟踪和解决问题:
报告 bug#
如果您遇到已确认的错误,请通过在相应的 Autoware 存储库中创建问题来报告它. 包括详细信息,例如重现步骤、预期结果和实际结果,以帮助维护人员及时解决问题.
跟踪任务#
GitHub Issues 也是管理任务的地方,包括:
- 重构: 建议重构现有代码以提高效率、可读性或可维护性.清楚地描述您建议重构的内容和原因.
- 新功能: 如果您通过讨论确认了对新功能的需求,请使用 Issues 来跟踪其发展.概述该功能的用途、潜在设计及其预期影响.
- 文档: 提议对文档进行更改以修复不准确之处、更新过时的内容或添加新部分.指定需要哪些更改以及这些更改为何重要.
创建 issue#
创建新 Issue 时,请遵循以下准则:
- 选择正确的存储库:如果不确定哪个存储库合适,请在 Q&A 类别 中发起讨论,寻求维护者的指导.
- 使用清晰、简洁的标题:清楚地总结标题中的问题或任务,以便快速识别.
- 提供详细说明: 包括所有必要的详细信息,以了解问题的背景和范围.在适用的情况下,附加屏幕截图、错误日志和代码片段.
- 标记相关贡献者:提及可能受问题影响或对问题感兴趣的贡献者或团队.
链接议题和拉取请求#
当您开始处理议题时,通过提及议题编号将相关的拉取请求链接到该议题. 这有助于维护清晰且可追溯的开发历史记录.
有关更多详细信息,请参阅 [拉取请求指南页面](../contributing/pull-request-guidelines/index.md 的 Package.
警告
GitHub Issues 不适用于问题或未确认的 bug.如果 issue 是出于此类目的创建的, 它可能会转移到 GitHub Discussions 以进一步澄清.
不和谐#
Autoware 有一个 Discord 服务器,用于贡献者之间的随意交流.
Autoware Discord 服务器是进行以下活动的好地方:
- 向社区介绍自己.
- 与贡献者聊天.
- 进行一次快速的稻草民意调查.
请注意,这不是获取问题帮助的合适位置.
ROS 话语#
如果您想与一般的 Autoware 和 ROS 社区广泛讨论某个主题,或者提出与 Autoware 的错误无关的问题,请在 ROS Discourse 上的 Autoware 类别 发帖.
警告
不要在 ROS Discourse 上发布有关错误的问题!