Instructions concernant les contributions
Welcome to the contribution guidelines for the frc-docs project. If you are unfamiliar to writing in the reStructuredText format, please read up on it here.
Important
FIRST® retains all rights to documentation and images provided. Credit for articles/updates will be in the GitHub commit history.
Mission
La mission de WPILib est de permettre aux équipes de la Compétition de robotique FIRST de se concentrer à rédiger du code lié au jeu de la saison plutôt que de se buter à des détails techniques - « élever le plancher sans abaisser le plafond ». Nous voulons permettre aux équipes avec peu de connaissances en programmation ou sans l’expertise de mentors de performer autant que possible, sans gêner les prouesses d’équipes avec plus de ressources avancées en matière de programmation. Les ressources concernant les composantes du système de contrôle du Kit de pièces se trouvent directement dans la bibliothèque. Nous tentons également de pourvoir équitablement les caractéristiques principales de chaque langage (Java, C++, et LabVIEW de NI), de telle sorte qu’il n’y ait pas de désavantage pour les équipes à choisir un langage plus qu’un autre.
Ces documents constituent un apprentissage de base pour toutes les équipes en Compétition de robotique FIRST. Toute contribution au projet doit respecter les principes suivants.
Une documentation issue de la communauté. Les sources sont disponibles publiquement et la communauté peut y contribuer.
Une documentation structurée, mise en page adéquatement et concise. La documentation doit être concise et facile à lire, tant du point de vue rédaction que diffusion.
Pertinence. La documentation doit porter sur la Compétition de robotique FIRST .
Consultez Conventions de style concernant la mise en forme des documents.
Processus de révision
frc-docs utilise un processus de révision spécial pour la gestion du site principal /stable/
et du site de développement /latest/
. Ce flux est détaillé ci-dessous.
Pendant la saison:
Validation (commit) effectuée sur la branche
main
Mises à jour
/stable/
et/latest/
sur le site web
À la fin de la saison:
Le référentiel est étiqueté avec l’année, à des fins d’archivage
Hors-saison:
La branche
/stable/
est verrouillée sur le dernier commit de la saisonValidation (commit) effectuée sur la branche
main
Seules les mises à jour
/latest/
sur le site de documentation
Création d’un PR
PRs should be made to the frc-docs repo on GitHub. They should point to the main
branch and not stable
.
Création de nouveaux contenus
Thanks for contributing to the frc-docs project! There are a couple things you should know before getting started!
Où placer les articles?
L’emplacement pour de nouveaux articles peut être un sujet très discutable. Les articles autonomes qui entrent bien dans une catégorie déjà soumise devraient être placés dans la catégorie des sujets mentionnés (la documentation sur un sujet relatif à la simulation devrait être placée dans la section simulation). Cependant, les choses peuvent devenir assez compliquées quand un article combine ou fait référence à deux sections existantes distinctes. Dans ce cas, nous conseillons à l’auteur d’ouvrir une question sur le dépôt pour faire en sorte que l’on puisse en discuter avant d’ouvrir le PR.
Note
Toutes les nouvelles publications seront soumises à un processus de révision avant d’être intégrées. Le processus de révision est assuré par des membres de l’équipe WPILib. Les nouvelles publications doivent porter sur les équipements ou les logiciels officiellement reconnus par FIRST. De la documentation portant sur des bibliothèques ou des capteurs non officiels « ne sera pas » acceptée. Le processus peut prendre un certain temps; soyez patient.
Où placer les sections?
Sections are quite tricky, as they contain a large amount of content. We advise the author to open an issue to gather discussion before opening up a PR.
Relier d’autres articles
Dans le cas où l’article fait référence au contenu décrit dans un autre article, l’auteur doit faire de son mieux pour établir un lien vers cet article dans la première référence.
Imaginez que nous avons le contenu suivant dans un tutoriel relatif à la base pilotable:
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.
Notez comment seule la première instance de Simulation est liée. C’est cette structure que l’auteur doit suivre. Il y a des moments où un article est lié a différents sujets dans son contenu. Si vous référez les différents types de contenu dans l’article, vous devez lier chaque nouvelle référence une fois (sauf dans les situations où l’auteur l’a jugé autrement approprié ).