beginner
Plantilla de Guía de Contribución
Una plantilla lista para usar con directrices de contribución para proyectos open-source e internos.
Temas: devops
Estructura de la plantilla
Usa esta plantilla para crear un archivo CONTRIBUTING.md en tu repositorio.
Contribuyendo a [Nombre del Proyecto]
¡Gracias por tu interés en contribuir! Este documento te guiará a través del proceso.
Tabla de contenidos
- Primeros pasos
- Cómo contribuir
- Configuración de desarrollo
- Estándares de código
- Proceso de pull request
- Reportar bugs
- Directrices de la comunidad
Primeros pasos
Prerrequisitos
- [Tool/Runtime] versión X o superior
- [Package manager] instalado
- Una cuenta de GitHub
Encontrar issues para trabajar
- Revisa las etiquetas good first issue
- Navega issues abiertos y comenta para reclamar
- Abre un issue nuevo si encuentras un bug o tienes una solicitud de feature
Cómo contribuir
Reportar bugs
- Busca issues existentes primero
- Abre un issue nuevo con la plantilla de reporte de bug
- Incluye:
- Pasos para reproducir
- Comportamiento esperado
- Comportamiento actual
- Detalles del entorno (OS, versión, etc.)
- Capturas de pantalla o logs si aplica
Sugerir features
- Abre un issue nuevo con la plantilla de solicitud de feature
- Describe el problema y la solución propuesta
- Discute con los mantenedores antes de invertir esfuerzo significativo
Configuración de desarrollo
# 1. Hacer fork y clonar
git clone https://github.com/[org]/[repo].git
cd [repo]
# 2. Instalar dependencias
[install command]
# 3. Crear una rama
git checkout -b feature/nombre-de-tu-feature
# 4. Verificar configuración
[test command]
Estándares de código
Guía de estilo
- Sigue [convenciones de lenguaje/framework]
- Ejecuta el linter antes de hacer commit:
[lint command] - Formatea el código con:
[format command]
Mensajes de commit
Usa conventional commits:
feat: add new feature
fix: resolve bug in module
docs: update documentation
refactor: restructure code
test: add missing tests
chore: update dependencies
Testing
- Agrega tests para nuevas features
- Asegúrate de que todos los tests pasen:
[test command] - Apunta a [coverage target]% de cobertura de código
Proceso de pull request
- Nombrado de ramas:
feature/descripcion,fix/descripcion,docs/descripcion - Commit: Sigue el formato de conventional commits
- Push: Sube a tu fork
- Abrir PR: Usa la plantilla de pull request
- Revisión: Responde al feedback de los revisores
- Merge: Los mantenedores harán merge una vez aprobado
Checklist de PR
- Tests agregados o actualizados
- Documentación actualizada
- Linter pasa
- Mensajes de commit siguen la convención
- Descripción del PR es clara y completa
Directrices de la comunidad
Código de conducta
- Sé respetuoso e inclusivo
- Enfócate en feedback constructivo
- Asume buena intención
- Reporta acoso a [contact email]
Reconocimiento
Los contribuidores serán:
- Listados en el README o archivo CONTRIBUTORS
- Mencionados en las release notes
- Acreditados apropiadamente en la historia del proyecto
¿Preguntas?
- Abre una Discussion para preguntas generales
- Únete a nuestro Discord/Slack para chat en tiempo real
- Email [contact email] para consultas privadas