合作者的说明和指南
我们衷心感谢您为帮助扩展和改进自动驾驶手册所做的贡献。目前,我们仅接受完整教程形式的贡献。如果您希望对现有教程提出更改,请使用 GitHub 问题部分。
这本食谱的主要动机是创建一系列教程,让初学者、研究人员和行业专家都受益。请确保您的教程是按照同样的思路和相似的目标准备的。您的教程可以满足其中一个或所有这些受众的需求。本食谱中的教程的目的不是展示前沿的研究技术或推广产品,而是为了减少刚刚开始或已经在自动驾驶领域工作的人们的进入壁垒。您的教程绝对应该利用新的研究技术和/或产品,但它们不应该成为主要焦点。重点需要放在读者可以通过学习您的教程来学习的新方法和技术,以及他们如何使用和扩展这些方法和技术来帮助他们实现个人目标。
如果您想向食谱添加新教程,请按照以下步骤操作。
## 第1步
- 确保您已阅读主 README 中的 Contributing 部分。
- 使用“新教程提案”标签创建新的 GitHub 问题。请提供以下信息:
1.教程标题
2. 简要说明(2-3句话)
3. 供我们团队与您联系的电子邮件地址
## 第2步
- 我们团队的人员将通过电子邮件与您联系,请求为您提议的教程撰写一页的文章。请确保您的寻呼机包含以下信息:
- 拟议教程的标题
- 作者单位名单
- 摘要
- 教程的建议格式(例如 Python 笔记本、带有代码片段的单个自述文件等)
- 将教程添加到说明书的理由:它是否涵盖了说明书中当前未包含的主题?
- 本教程使用的技术列表
- 本教程的目标受众
- 一旦我们收到您的单页寻呼机,我们的团队将与您合作以获取任何其他详细信息并根据需要提供建议。
步骤 3
如果团队决定继续将建议的教程添加到说明书中,我们将与您一起在新分支上准备教程,一旦教程准备好,该分支将合并到主分支。
在学习教程时,请确保以下事项:
- 整个教程和任何相关文件应位于主存储库的单个文件夹中。
- 不应签入任何不相关的本地文件。使用 .gitignore 文件来帮助解决此问题。
- 不应签入教程所需的任何数据。只要有必要,应在教程内提供数据集的下载链接。如果您使用的数据集不属于您,请确保您拥有必要的权限并适当地承认所有者。
- 您的教程需要有一个 README.md 文件,其中包含以下部分(根据需要):
- 教程标题
- 作者和隶属关系
-
概述: 本节应用 3-5 句话阐述本教程的目的。它还应该告诉读者在完成教程后他们可以期望实现什么。
-
教程的结构: 使用本节来描述教程的设置和布局以及读者应该从哪里开始。
-
先决条件和设置:
- 需要背景
- 环境设置(如果有)
- 硬件设置(如果有)
- 有关使用的数据集的信息(如果有)
- 补充说明
-
参考文献,如果有的话
- 请确保适当地确认您在本教程中使用的任何参考文献。为此,您可以使用自述文件中的参考部分,或者您可以直接从教程内容链接到引用的材料。