Contribution Guidelines.md

Guía para Contribuciones

Nuevo en LaTeX vea este curso

A continuación encuentra los principales lineamientos para contribuir a este repositorio de ejemplos de código LaTeX - LaTeXamples -. La estructura de desarrollo para este proyecto esta basada en dos ejes:

• Invitación a usuarios avanzados que quieran pertener al equipo de mantenedores liderado por uno o dos líderes de proyecto.
• Participación abierta donde cualquiera puede contribuir utilizando el proceso estándar de GitHub.

El Feedback y contribuciones de cualquiera son bienvenidos. Sientase libre de contactarnos para discutir cualquier idea adicional.

Este proyecto se encuentra en una etapa temprana de desarrollo y se alimenta principalmente de las contribuciones hechas por voluntari@s.

Contacto

Si usted quiere hacer parte del equipo de mantenedores por favor primero únase al grupo de Telegram, segundo regístrese usted mismo en la lista de mantenedores y tercero póngase en contacto con el líder de proyecto.

Si tiene dudas acerca del este proyecto, por favor contactenos directamente.

También puede estar al tanto del proyecto a través de Twitter.

Para patrocinios, por favor contáctenos aquí.

Primeros pasos

• Si es nuevo en GitHub pero quiere unirse al equipo de mantenedores, contribuir código o reportar issues (errores, sugerencias, etc) vea este curso (próximamente).
• Conozca la estructura del repositorio, sus directorios y organización de contenido, algunos archivos de documentación están construidos con Markdown aquí hay una guía de escritura con Markdown que puede consultar.
• Conozca y pruebe los macros LaTeX2Code que le ayudarán a generar ejemplos de código LaTeX, antes de proponer sus propios ejemplos.

Reportar Issues

• Haga una búsqueda por los issues existentes. Por favor revise si los incidentes o sugerencias que quiere reportar no han sido reportados ya por alguien más.
• Comparta la mayor cantidad de información posible. Incluya sistema operativo, versión de la distribución de LaTeX y editor que este usando, navegador y versión (si se trata de Overleaf). También incluya los pasos que ha seguido para compilar su documento para que podamos reproducir el error.

Configuración del proyecto

Refiérase al Readme

Estilo del contenido

El estilo seguido para desarrollar ejemplos es flexible, sin embargo se recomienda hacer uso de los macros LaTeX2Code.

Las contribuciones deben estar conformadas por:

• ejemplos
  • Dos archivos: .tex con las fuentes completas del ejemplo y .pdf que presente el resultado y el código empleado para obtenerlo. Si se requieren macros o configuraciones adicionales que no se definan en el preámbulo del .tex deben suministrarse también sus fuentes.
• macros, paquetes, clases, plantillas:
  • Tres Archivos: Fuentes (.tex, sty o cls), manual de usario .pdf y fuentes del manual de usuario .tex.

En cualquier caso las fuentes deben estar debidamente licenciadas (¿nuev@ en el proceso de licenciamiento? vea este vídeo - próximamente -).

Estilo de código

Respecto al código de paquetes y plantillas lo único que se recomienda es que el código esté debidamente documentado para facilitar su uso - preferentemente incluir ejemplos de uso con fuentes (.tex) y resultados (.pdf) -.

Pull requests

Antes de hacer pull request!

• Haga fork al repositorio en GitHub
• Clone el proyecto en su propia máquina
• Haga los commits en su propio branch
• Push su trabajo a su propio fork
• Haga un pull request al proyecto principal para que podamos revisar sus aportes
• Procure no hacer pull request con cambios mínimos, esto facilitará nuestra lectura de los commits.
• Procure asegurarse de que ha probado todo su código antes de hacer pull request
• Si su pull request resuelve un issue, agregue #ISSUE_(NÚMERO) CERRADO en el mensaje de su commit.
• Revisión
  • Si su pull request esta listo para revisión, la revisión será asignada a alguno de los mantenedores.
  • La revisión será aceptada o comentada en el pull request.
  • Si necesita responder a un comentario de revisión, hágalo en los mensajes del pull request.
  • Una vez su código sea aceptado, será mezclado al master branch.