Skip to content

This page is available in English and Spanish.
Esta página está disponible en inglés y en español.

🇺🇸 ENGLISH VERSION

Contributing to Team Documentation

This page outlines how members of the research team can contribute to improving and maintaining our shared documentation.

Why Contribute?

  • Improve the resource for everyone — Your experience helps strengthen materials for current and future members.
  • Develop professional skills — Writing and maintaining technical documentation is essential in research and industry.
  • Strengthen the team — Collaborative documentation supports knowledge transfer and continuity.

How to Contribute

Small Changes (Typos, Minor Clarifications)

  1. Create an Issue
  2. Go to the repository Issues tab
  3. Use a clear title and briefly describe the change

  4. Label appropriately (e.g., "typo", "clarification")

  5. Direct Edit / Pull Request

  6. For simple changes, edit the file directly on GitHub
  7. Submit a pull request with a short explanation

Larger Contributions (New Content, Major Revisions)

  1. Discuss First
  2. Open an issue describing your proposed contribution

  3. Wait for feedback before proceeding

  4. Fork and Work Locally

  5. Fork the repository and create a new branch

  6. Make your changes following the existing style

  7. Submit a Pull Request

  8. Clearly explain what you added and why it is useful

Content Guidelines

When contributing content:

  • Be clear and concise — Prioritize readability
  • Be accurate — Verify technical information
  • Follow structure — Match formatting and organization
  • Consider all members — Content should support undergraduate and graduate students
  • Respect confidentiality — Do not include sensitive or restricted information

Document Structure Guidelines

  • Use proper Markdown headings (#, ##, ###)
  • Use bullet points or numbered lists when appropriate
  • Link to relevant internal documents when useful
  • Keep formatting consistent across pages

Language Guidelines

  • Whenever possible, provide both English and Spanish versions
  • If you are only able to contribute in one language, clearly indicate this
  • If translation help is needed, coordinate with the team

Review Process

  • Contributions will be reviewed by team leads or designated maintainers
  • Feedback may be provided before approval
  • Approved contributions will be merged into the main repository

Getting Help

If you have questions about contributing:

  • Reach out to a team lead
  • Ask within the team communication channels

Recognition

All contributors help improve the team and may be acknowledged within the repository.

🇨🇴 VERSIÓN EN ESPAÑOL

Contribución a la Documentación del Equipo

Esta página describe cómo los miembros del equipo de investigación pueden contribuir a mejorar y mantener la documentación compartida.

¿Por qué contribuir?

  • Mejorar el recurso para todos — Su experiencia fortalece el material para miembros actuales y futuros
  • Desarrollar habilidades profesionales — La documentación técnica es clave en investigación e industria
  • Fortalecer el equipo — La documentación colaborativa facilita la transferencia de conocimiento

Cómo contribuir

Cambios pequeños (errores tipográficos, aclaraciones)

  1. Crear un Issue
  2. Ir a la pestaña de Issues del repositorio
  3. Usar un título claro y describir brevemente el cambio

  4. Etiquetar adecuadamente (ej. "typo", "clarification")

  5. Edición directa / Pull Request

  6. Para cambios simples, editar directamente en GitHub
  7. Enviar un pull request con una breve descripción

Contribuciones grandes (nuevo contenido, revisiones mayores)

  1. Discutir primero
  2. Crear un issue describiendo la propuesta

  3. Esperar retroalimentación antes de avanzar

  4. Fork y trabajo local

  5. Hacer fork del repositorio y crear una rama nueva

  6. Realizar cambios siguiendo el estilo existente

  7. Enviar Pull Request

  8. Explicar claramente qué se añadió y por qué es útil

Lineamientos de contenido

Al contribuir:

  • Ser claro y conciso — Priorizar la legibilidad
  • Ser preciso — Verificar la información técnica
  • Seguir la estructura — Mantener formato consistente
  • Considerar a todos los miembros — Incluir pregrado y posgrado
  • Respetar la confidencialidad — No incluir información sensible

Estructura de documentos

  • Usar encabezados Markdown adecuados (#, ##, ###)
  • Usar listas para mayor claridad
  • Incluir enlaces a documentos relevantes
  • Mantener consistencia en el formato

Lineamientos de idioma

  • Siempre que sea posible, incluir versiones en inglés y español
  • Si solo contribuye en un idioma, indicarlo claramente
  • Si necesita ayuda con traducción, coordinar con el equipo

Proceso de revisión

  • Las contribuciones serán revisadas por líderes o responsables del equipo
  • Puede haber retroalimentación antes de la aprobación
  • Las contribuciones aprobadas serán integradas al repositorio principal

Obtener ayuda

Si tiene dudas:

  • Contactar a un líder del equipo
  • Consultar en los canales de comunicación del equipo

Reconocimiento

Todas las contribuciones ayudan a mejorar el equipo y podrán ser reconocidas dentro del repositorio.