文档贡献规则

欢迎来到 frc®-docs 项目的捐款指南。如果您不熟悉在 reStructuredText 版式上写,请仔细阅读 here

重要

FIRST® 保留被提供文档和图像的所有的权利。文章 / 更新 的积分将记录在 GitHub commit history.

使命宣言

WPILib 的任务是让 FIRST 机器人团队专注于编写游戏专用软件,而不是专注于硬件细节—— “raise the floor, don’t lower the ceiling” 。我们致力于使具有有限编程知识和/或指导经验的团队尽可能成功,同时不妨碍具有更高级编程能力的团队的能力。我们在库中直接支持零件控制系统组件套件。我们还努力保持每个语言(java,C++,和 NI 的 LabVIEW)的主要特征之间的奇偶性,这样团队就不会因为选择特定的编程语言而处于不利的地位。

这些文档为所有 FIRST 机器人竞赛团队提供了一个学习场所。对该项目的捐赠必须遵循这些核心原则。

  • 社区主导的文档。文档来源是公开托管的,社区可以参与捐赠

  • 结构化、格式好、清晰的文档。从源代码和发布的角度来看,文档应该是干净且易于阅读的

  • 息息相关。文档应该集中注意在* FIRST *机器人大赛上。

查阅:ref:`docs/contributing/frc-docs/style-guide:Style Guide`了解如何规范化您的文档。

发布过程

frc-docs使用特殊的发行过程来处理主站点``/ stable /’’和开发站点``/ latest /’’。该流程将在下面详细说明。

在赛季中:-提交到“主要”分支

  • 更新网站上的 /stable/``和/latest/``

赛季末: - Repository被标签上年份方便存储

在季后赛中:-“稳定”分支被锁定到最后一个季节性提交-对“主要”分支进行的提交

  • 指更新文档站点中的``/latest/``

创建一个PR

应该在GitHub上的`frc-docs <https://github.com/wpilibsuite/frc-docs>`__仓库中进行PR。它们应指向“ main”分支,并指向“ not”“ stable”。

增加新内容

感谢您为`frc-docs <https://github.com/wpilibsuite/frc-docs>`__项目做出贡献!开始之前,希望您了解下几件事!

文章放在哪呢?

新文章的位置可能是一个很主观的问题。属于现存主题分类的独立文章应放在提及的主题类别中(有关模拟的文档应放在模拟部分中)。但是,当文章结合或引用两个单独的现有部分时,事情可能会变得非常复杂。在这种情况下,我们建议作者在打开PR之前先在存储库中打开一个repository,以进行讨论。

注解

所有新文章在合并到repository之前都将经过审核过程。审核过程将由WPILib团队的成员来完成。新文章必须在受* FIRST *支持的官方软件和硬件上。 关于非官方图书馆或传感器的文件不会被接受。该过程可能需要一些时间进行审核,请耐心等待。

在哪里放置章节?

章节是相当棘手的,因为它们包含大量的内容。我们建议作者在打开PR之前先打开以“issue <https://github.com/wpilibsuite/frc-docs/issues> ‘ __来聚集讨论。