贡献者指南#

导言#

你好,感谢你花时间考虑为 Game Manual 0 做出贡献。你的知识和贡献将帮助许多其他团队,并使 Game Manual 0 成为一个通用资源。本文档旨在介绍为 Game Manual 0 做出贡献的基本概况。

谁能做出贡献?#

Game Manual 0 欢迎任何人投稿。本指南的大部分内容都是由 FTC® 来自不同团队的优秀学生与导师和校友共同撰写的。我们的编辑控制完全基于内容,只要内容好,就会被添加到 Game Manual 0。

Game Manual 0 的目标#

在撰写之前,请花点时间熟悉一下 Game Manual 0 的目标。主要目标是:

  1. 向新团队、参赛者和教练介绍并指导 FIRST® 科技挑战赛,帮助他们实现竞赛目标。

  2. 作为与 FIRST 科技挑战赛相关的结构、技术和社区知识的活参考资料。

这些目标看似不言自明,但却有几个重要的启示。

  • 这些目标并不一定相互依存。 例如,让我们看看 传动系统 部分。如果我们只是想引导更多菜鸟车队走向成功,我们就会讨论车队可能会遇到的非常流行的动力传动系统(2WD、4WD、6WD、mecanum、X-Drive 和 H-Drive),这样车队就可以快速上手并选择有竞争力的动力传动系统。但是,如果我们的目标是成为一个全面的参考资料,那么我们就会包括所有可能的 FTC 传动系统,即使这些传动系统对于新车队来说不是很有竞争力或不现实(swerve、ball、octocanum 等)。

    • 我们希望通过一种新的结构来实现这两个目标:将会有一个“面向新手”页面,它将链接到一个专为新手设计的页面列表,而这个列表之外的页面可以作为更全面的参考。

    • 在撰写时要牢记页面的目标,以及是否要将其保留在“面向新手”页面上,并相应调整内容。

  • Game Manual 0 主要是从竞技角度出发的指南。 一般来说,我们建议的最终目标是在团队的限制范围内提高团队得分,并培养良好的技术习惯,这对未来的职业生涯非常有用。

  • Game Manual 0 旨在提供信息,而不是告诉别人。 Game Manual 0 并不希望鼓励一种“元”设计或一系列技术,相反,本指南旨在为团队提供多种选择,并列出每种选择的利弊,让团队根据自身情况做出决定。如果要提出建议,则必须基于客观、可重复的推理。有关这方面的更多信息,请阅读 风格指南

  • Game Manual 0 通常是一个高水平的概念指南。 这意味着所提供的信息适用于多种情况,而不是一系列步骤。不过,在可能的情况下,我们会链接到外部文档,以填补知识空白。例如:在电子部分,我们不讨论如何使用 REV 控制系统为机器人精确布线,而是链接到 REV 文档以了解精确布线,并讨论一般布线最佳实践。

开始投稿#

  1. 通读本文件

  2. 阅读 风格指南 手册

  3. 查看 项目列表GitHub 问题

  4. 查看 贡献方式 文件