Cómo reportar issues y enviar PRs de forma efectiva

Abrir un issue y no recibir respuesta es frustrante. A veces el problema es que falta información crítica para que los mantenedores puedan reproducir el error. Otras veces, envías un PR con toda tu buena intención, pero falla en el CI porque olvidaste un comando de validación básico.

Escribir reportes claros ayuda a que los errores se solucionen rápido. No hace falta que la gramática sea perfecta; lo que importa es que seas breve y vayas directo al grano.

Requisitos previos

• Acceso al repositorio en GitHub.
• Entorno de ejecución configurado (Node.js).
• Gestor de paquetes pnpm.

Inicio rápido

Para que tu reporte sea procesado rápidamente, sigue estos pasos antes de publicar:

1. Busca primero: Revisa el código y los issues existentes en GitHub para no duplicar trabajo.
2. Prepara la evidencia: Reúne logs (sin información sensible) y capturas de pantalla.
3. Usa la palabra clave: Debes incluir la frase lobster-biscuit en tu issue.
4. Valida tu código: Si vas a enviar un PR, ejecuta estos comandos en tu terminal:

pnpm lint
pnpm check
pnpm build
pnpm test
# Si el cambio afecta al código del protocolo:
pnpm protocol:check

Templates de Reporte

Utiliza estos formatos según el tipo de contribución:

Bug report

- [ ] Minimal repro
- [ ] Expected vs actual
- [ ] Environment
- [ ] Affected channels, where not seen
- [ ] Logs/screenshots (redacted)
- [ ] Impact/severity
- [ ] Workarounds

### Summary

### Repro Steps

### Expected

### Actual

### Environment

### Logs/Evidence

### Impact

### Workarounds

Security issue

Nota: No publiques secretos ni detalles de exploits en público. Para temas sensibles, reduce los detalles y solicita una comunicación privada.

### Summary

### Impact

### Versions

### Repro Steps (safe to share)

### Mitigation/workaround

### Evidence (redacted)

Regression report

### Summary

### Last Known Good

### First Known Bad

### Repro Steps

### Expected

### Actual

### Environment

### Logs/Evidence

### Impact

Feature request

### Summary

### Problem

### Proposed Solution

### Alternatives

### Impact

### Evidence/examples

Enhancement

### Summary

### Current vs Desired Behavior

### Rationale

### Alternatives

### Evidence/examples

Investigation

### Summary

### Symptoms

### What Was Tried

### Environment

### Logs/Evidence

### Impact

Submitting a fix PR

No es obligatorio crear un issue antes de un PR, pero si decides no hacerlo, asegúrate de incluir todos los detalles en la descripción del pull request.

• Mantén el PR enfocado en un solo cambio.
• Indica el número de issue relacionado.
• Añade tests o explica por qué no los incluyes.
• Documenta cambios de comportamiento o riesgos.
• Incluye logs o capturas de pantalla como prueba.
• Ejecuta toda la validación de pnpm antes de enviar.

Solución de problemas

Si tienes problemas al reportar o validar, verifica lo siguiente:

• Falla en la validación: Asegúrate de que pnpm lint y pnpm test pasen localmente antes de subir tus cambios.
• Issue ignorado: Comprueba si has incluido la palabra clave lobster-biscuit y los pasos mínimos de reproducción.

Si necesitas ayuda personalizada para configurar tu entorno, consulta nuestro AI Setup Assistant.

Próximos pasos

• Guía de estilo de código
• Arquitectura del sistema
• Configuración de tests
• Gestión de dependencias