贡献指南#
欢迎来到6940swerve-docs项目的贡献指南。如果你不熟悉用reStructuredText格式写作,请在 这里 上阅读。
创建一个PR#
PR应该被放到GitHub上的 6940swerve-docs 仓库。它们应该指向 “master “分支,而不是*”stable “分支。
创建新内容#
感谢你对 6940swerve-docs 项目的贡献!在开始之前,有几件事情你应该知道!
在哪里放置文章?#
新文章的位置可以是一个相当有意见的主题。独立的文章,如果属于一个已经存在的主题类别,就应该放在提到的主题类别中(关于模拟的文件应该放在模拟部分)。然而,当一篇文章结合或引用两个独立的现有章节时,事情就会变得非常复杂。在这种情况下,我们建议作者在发布PR之前,先在资源库上开一个issue,让大家讨论一下。
备注
所有的新文章在合并到资源库之前都会经过一个审查过程。这个审查过程将由WPILib团队的成员完成。新文章必须是关于官方*FIRST*支持的软件和硬件。非官方的库或传感器的文档将不被接受。这个过程可能需要一些时间来审查,请耐心等待。
在哪里放置章节?#
章节是相当棘手的,因为它们包含大量的内容。我们建议作者在创建PR之前,先创建一个 issue 来收集讨论。
链接其他文章#
如果文章引用了另一篇文章中描述的内容,作者应尽最大努力在第一次引用时链接到该文章。
想象一下,我们在传动系统的教程中,有以下内容。
Teams may often need to test their robot code outside of a competition. :ref:`Simulation <link-to-simulation:simulation>` is a means to achieve this. Simulation offers teams a way to unit test and test their robot code without ever needing a robot.
请注意,只有Simulation的第一个实例被链接。这就是作者应该遵循的结构。有的时候,一篇被链接的文章有不同的内容主题。如果你引用了文章中的不同类型的内容,你应该对每个新的参考文献进行一次链接(除非作者认为不合适)。