Guide du contributeur¶
Introduction¶
Bonjour, et merci de prendre le temps de envisager de contribuer à Game Manual 0. Votre savoir et vos contributions aideront de nombreuses autres équipes et amélioreront Game Manual 0 en tant que ressource universelle. Ce document est conçu pour fournir un aperçu de base sur la manière de contribuer à Game Manual 0.
Qui peut contribuer?¶
Game Manual 0 accueille les contributions de pratiquement tout le monde. La majorité de ce guide a été rédigée par des étudiants accomplis de FTC® provenant de diverses équipes, ainsi que par des mentors et des anciens. Notre contrôle éditorial repose uniquement sur le contenu ; tant que celui-ci est de qualité, il sera ajouté à Game Manual 0.
Les objectifs de Game Manual 0¶
Avant d’écrire, veuillez prendre le temps de vous familiariser avec les objectifs de Game Manual 0. Les objectifs principaux sont :
Informer et guider les nouvelles équipes, participants et entraîneurs du Défi Techno FIRST® et les aider à atteindre leurs objectifs compétitifs.
Agir en tant que référence vivante pour les mécanismes, techniques et connaissances communautaires pertinentes pour le Défi Techo FIRST.
Ces objectifs peuvent sembler relativement évidents, mais ils comportent plusieurs points importants à retenir.
Ces objectifs ne se construisent pas nécessairement les uns sur les autres. Par exemple, prenons la section :doc:/docs/common-mechanisms/drivetrains/index. Si l’objectif est simplement de guider les équipes débutantes sur la voie du succès, nous parlerions des drivetrains populaires que les équipes peuvent rencontrer (2RM, 4RM, 6WD, mecanum, X-Drive, et H-Drive) afin qu’elles puissent rapidement se mettre à niveau et choisir un châssis compétitif. Cependant, si l’objectif est d’être une référence complète, nous inclurions chaque châssis possible jamais créé pour FTC, même ceux qui ne sont pas très compétitifs ou réalistes pour les équipes plus récentes à construire (swerve, ball, octocanum, etc).
Nous cherchons à accomplir les deux objectifs avec une nouvelle structure : il y aura une page « Pour les débutants », qui renverra à une liste de pages sélectionnées et conçues pour les débutants, tandis que les pages en dehors de cette liste pourront servir de références plus complètes.
Gardez à l’esprit l’objectif de la page et si elle est conçue pour figurer sur la page « Pour les débutants » lors de l’écriture, et ajustez le contenu en conséquence.
Game Manual 0 est un guide principalement du point de vue compétitif. En général, nos recommandations ont pour objectif final d’augmenter le nombre de points marqués par une équipe tout en travaillant dans les limites de l’équipe, et de développer de bonnes habitudes techniques qui seront utiles dans une future carrière.
Game Manual 0 cherche à informer, pas à dicter. Game Manual 0 ne souhaite pas encourager un design ou une série de techniques « meta », mais plutôt présenter aux équipes une variété d’options, avec une liste des avantages et des inconvénients de chacune, et laisser les équipes prendre leurs propres décisions en fonction de leurs circonstances. Si des recommandations sont faites, elles doivent être basées sur un raisonnement objectif et reproductible. Pour plus d’informations à ce sujet, consultez le :doc:style-guide.
Game Manual 0 est généralement un guide de concepts de haut niveau. Cela signifie que l’information est présentée de manière à être applicable à de nombreuses situations, plutôt que sous forme de séries d’étapes. Cependant, lorsque cela est possible, nous fournissons des liens vers des documentations externes pour combler les lacunes de connaissances. Par exemple : dans les sections électroniques, nous ne discutons pas de la manière exacte de câbler le robot en utilisant le système de contrôle REV, mais nous renvoyons à la documentation REV pour le câblage précis et abordons les meilleures pratiques générales de câblage.
Commencer À Contribuer¶
Lisez ce document.
Lisez le Style Guide
Examinez la Liste de projets and GitHub issues
Consultez le Méthodes de contribution