Guía del colaborador#

Introducción#

Hola, y gracias por tomarte el tiempo para considerar contribuir al Game Manual 0. Tu conocimiento y contribuciones ayudarán a muchos otros equipos y mejorarán Game Manual 0 como un recurso universal. Este documento está diseñado para brindar una visión general básica de cómo contribuir a Game Manual 0.

¿Quién puede contribuir?#

Game Manual 0 da la bienvenida a las contribuciones de prácticamente cualquier persona. La mayoría de esta guía fue escrita por estudiantes destacados de FTC® de una amplia variedad de equipos, junto con mentores y exalumnos. Nuestro control editorial se basa puramente en el contenido, siempre y cuando el contenido sea bueno, se agregará a Game Manual 0.

Metas de Game Manual 0#

Antes de escribir, por favor tómate el tiempo para familiarizarte con los objetivos de Game Manual 0. Los objetivos principales son:

  1. Informar y guiar a los equipos más nuevos, participantes y entrenadores del FIRST® Tech Challenge y ayudarles a alcanzar sus objetivos competitivos.

  2. Actuar como una referencia viva para los mecanismos, técnicas y conocimiento comunitario pertinentes a FIRST Tech Challenge.

Estos objetivos pueden parecer relativamente autoexplicativos, pero tienen varios puntos importantes a tener en cuenta.

  • Estos objetivos no necesariamente se construyen uno sobre otro. Por ejemplo, veamos la sección /docs/mecanismos-comunes/chasis/índice. Si queremos simplemente guiar a más equipos novatos en el camino hacia el éxito, discutiríamos los trenes de transmisión más populares que los equipos pueden encontrar (2WD, 4WD, 6WD, mecanum, X-Drive y H-Drive) para que los equipos puedan ponerse al día rápidamente y elegir un chasis competitivo. Sin embargo, si el objetivo es ser una referencia completa, incluiríamos todos los chasises posibles que se hayan creado para FTC, incluso si no son muy competitivos o realistas para que los equipos nuevos los construyan (swerve, ball, octocanum, etc).

    • Buscamos lograr ambos objetivos con una nueva estructura: habrá una página «Para principiantes» que enlazará a una lista de páginas seleccionadas diseñadas para principiantes, mientras que las páginas fuera de esta lista pueden actuar como referencias más completas.

    • Mantén en mente el objetivo de la página y si está diseñada para ser mantenida en la página «Para principiantes» mientras escribes, y ajusta el contenido en consecuencia.

  • El Game Manual 0 es una guía principalmente desde un punto de vista competitivo. En general, nuestras recomendaciones tienen como objetivo final aumentar los puntos anotados por un equipo mientras se trabaja dentro de las limitaciones del equipo y se desarrollan buenos hábitos técnicos que serán útiles en una futura carrera.

  • Game Manual 0 busca informar, no decir. Game Manual 0 no desea fomentar un diseño «meta» o una serie de técnicas, en cambio, la guía busca presentar a los equipos una variedad de opciones, con una lista de pros y contras de cada una, y permitir que los equipos tomen sus propias decisiones según sus propias circunstancias. Si se dan recomendaciones, deben basarse en un razonamiento objetivo y repetible. Para obtener más información al respecto, lee la guía-de-estilo.

  • El Game Manual 0 es generalmente una guía de conceptos de alto nivel. Esto significa que la información se presenta de una manera aplicable a muchas situaciones, en lugar de una serie de pasos. Sin embargo, cuando sea posible, enlazamos a documentación externa para cubrir cualquier brecha de conocimiento. Por ejemplo: en las secciones de electrónica, no discutimos cómo cablear exactamente el robot utilizando el sistema de control REV, en su lugar, enlazamos a la documentación de REV para el cableado exacto y discutimos las mejores prácticas generales de cableado.

Comenzando a contribuir#

  1. Lee este documento

  2. Lee guía-de-estilo

  3. Revisa la Lista de Proyectos y los problemas de GitHub

  4. Revisa los métodos-de-contribución