Issues

Solucionar un issue existente

Una de las mejores formas de ayudar a mejorar la documentación es solucionar un issue existente.

1. Navega por la lista de issues.

2. Selecciona un issue en el que te gustaría trabajar.

   ¡Importante!

   Asegúrate de elegir un issue que coincida con tu nivel de experiencia y conocimiento de OpenTelemetry. Evita abarcar más de lo que puedes manejar.

3. Lee los comentarios del issue, si los hay.

4. Pregunta a los mantenedores si este issue sigue siendo relevante, y haz cualquier pregunta que necesites para aclarar dudas publicando comentarios en el issue.

5. Comparte tu intención de trabajar en el issue agregando un comentario a este efecto.

6. Trabaja en solucionar el issue. Avisa a los mantenedores si encuentras algún problema.

7. Cuando esté listo, envía tu trabajo mediante un pull request (PR).

Reportar un issue

Si notas un error o quieres sugerir mejoras al contenido existente, abre un issue.

1. Haz clic en el enlace Create documentation issue en cualquier documento. Esto te redirige a una página de issue de GitHub precargada con algunos encabezados.
2. Describe el issue o la sugerencia de mejora. Proporciona tantos detalles como sea posible.
3. Haz clic en Create.

Después de enviar, revisa tu issue ocasionalmente o activa las notificaciones de GitHub. Puede tomar algunos días hasta que los mantenedores y aprobadores respondan. Los revisores y otros miembros de la comunidad pueden hacer preguntas antes de poder tomar acción sobre tu issue.

Sugerir nuevo contenido o funcionalidades

Si tienes una idea para nuevo contenido o una funcionalidad, pero no estás seguro de dónde debería ir, aún puedes crear un issue. También puedes reportar errores y vulnerabilidades de seguridad.

1. Ve a GitHub y selecciona New issue dentro de la pestaña Issues.

2. Selecciona el tipo de issue que mejor aplique a tu solicitud o duda.

3. Completa la plantilla.

4. Envía el issue.

Cómo crear buenos issues

Ten en cuenta lo siguiente al crear un issue:

• Proporciona una descripción clara del issue. Describe específicamente qué falta, qué está desactualizado, qué está mal o qué necesita mejorarse.
• Explica el impacto específico que tiene el issue en los usuarios.
• Limita el alcance de un issue dado a una unidad de trabajo razonable. Para problemas con un alcance grande, divídelos en issues más pequeños. Por ejemplo, “Arreglar los docs de seguridad” es demasiado amplio, pero “Agregar detalles al tema ‘Restringir el acceso a la red’” es lo suficientemente específico como para ser accionable.
• Busca en los issues existentes para ver si hay algo relacionado o similar al nuevo issue.
• Si el nuevo issue se relaciona con otro issue o pull request, refiérelo ya sea por su URL completa o por el número del issue o pull request precedido por un carácter #. Por ejemplo, Introducido por #987654.
• Sigue el Código de Conducta. Respeta a tus compañeros contribuyentes. Por ejemplo, “Los docs son terribles” no es un comentario útil ni cortés.