Guías de Contribución

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.

Importante

FIRST® conserva todos los derechos sobre la documentación y las imágenes proporcionadas. El crédito por artículos / actualizaciones estará en GitHub commit history.

Misión

La misión de WPILib es hace posible a los equipos de FIRST Robotics concentrarse en el desarrollo de software específico para el juego en vez de centrar su atención en detalles de hardware. Trabajamos para ayudar a los equipos con conocimientos de programación limitados y/o experiencia de sus mentores a ser tan exitosos como sea posible, sin obstaculizar las habilidades de los equipos con capacidades mayores de programación. Tenemos soporte directo en nuestras librerías de los componentes del sistema de control del Kit of Parts. También nos esforzamos al máximo para mantener una paridad entre las características principales de cada lenguaje (Java, C++ y LabVIEW), para que los equipos no tengan desventaja alguna al escoger su lenguaje de programación.

Estos documentos sirven para proporcionar un campo de aprendizaje para todos los equipos de FIRST Robotics Competition. Las contribuciones al proyecto deben seguir estos principios básicos.

  • Documentación dirigida por la comunidad. Las fuentes de la documentación se alojan públicamente y la comunidad puede hacer contribuciones.

  • Documentación estructurada, con buen formato, y limpia. La documentación debe ser limpia y fácil de leer, tanto desde el punto de vista de la fuente como de la versión.

  • Relevante. La documentación debe centrarse en el FIRST Robotics Competition.

Consulte el Guía de Estilo para obtener información sobre cómo diseñar su documentación.

Proceso de liberación

frc-docs utiliza un proceso de liberación especial para manejar el sitio principal /stable/ y el sitio de desarrollo /latest/. Este flujo se detalla a continuación.

Durante la temporada:

  • Commit hecho en la rama main

    • Actualiza /stable/ y /latest/ en el sitio web

Fin de la temporada:

  • El repositorio está etiquetado con el año, para propósitos de archivo.

Off-Season:

  • La rama stable se bloquea con el ultimo commit hecho en temporada

  • Commit hecho en la rama main

    • Sólo se actualiza /latest/ en el sitio de documentación

Creando un PR

Los PRs deben hacerse en el repositorio frc-docs en GitHub. Deben apuntar a la rama main y no a stable.

Crear Contenido Nuevo

¡Gracias por contribuir al proyecto frc-docs ! ¡Hay algunas cosas que debería saber antes de iniciar!

¿Dónde colocar los artículos?

La ubicación de los nuevos artículos puede ser un tema bastante obstinado. Los artículos independientes que caen bien en una categoría de tema ya deben colocarse en la categoría de tema mencionada (la documentación sobre algo sobre simulación debe colocarse en la sección de simulación). Sin embargo, las cosas pueden complicarse bastante cuando un artículo combina o hace referencia a dos secciones existentes separadas. En esta situación, recomendamos al autor que abra un número en el repositorio para iniciar la discusión antes de abrir el PR.

Nota

Todos los artículos nuevos se someterán a un proceso de revisión antes de fusionarse en el repositorio. Este proceso de revisión será realizado por miembros del equipo de WPILib. Los nuevos artículos deben ser sobre software y hardware oficial compatible con FIRST. La documentación sobre bibliotecas o sensores no oficiales no será aceptada. Este proceso puede tomar tiempo de revisar, por favor sea paciente.

¿Dónde colocar las secciones?

Las secciones son bastante complicadas, ya que contienen una gran cantidad de contenido. Aconsejamos al autor que abra un issue para entablar una discusión antes de abrir un PR.