Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
227 lines (160 loc) · 5.18 KB

CONTRIBUTING.md

File metadata and controls

227 lines (160 loc) · 5.18 KB

🤝 Guía de Contribución

¡Gracias por tu interés en contribuir a Git Multi-Account Windows SSH! Este documento te guiará en el proceso de contribución.

📋 Tabla de Contenidos

📜 Código de Conducta

Este proyecto sigue los principios de respeto, colaboración y profesionalismo. Esperamos que todos los contribuidores:

  • Sean respetuosos con otros colaboradores
  • Acepten críticas constructivas
  • Se enfoquen en lo que es mejor para la comunidad
  • Muestren empatía hacia otros miembros de la comunidad

🚀 ¿Cómo puedo contribuir?

Reportar Bugs

Si encuentras un bug, por favor crea un issue con:

  1. Título descriptivo del problema
  2. Pasos para reproducir el error
  3. Comportamiento esperado vs. comportamiento actual
  4. Versión de Windows y versión de Git
  5. Logs o capturas de pantalla si es posible

Sugerir Mejoras

Para sugerir nuevas funcionalidades:

  1. Verifica que no exista un issue similar
  2. Crea un nuevo issue describiendo:
    • El problema que resuelve tu sugerencia
    • Cómo debería funcionar
    • Posibles alternativas que consideraste

Pull Requests

  1. Fork el proyecto
  2. Crea una rama para tu feature (git checkout -b feature/AmazingFeature)
  3. Haz commit de tus cambios (git commit -m 'Add some AmazingFeature')
  4. Push a la rama (git push origin feature/AmazingFeature)
  5. Abre un Pull Request

🔧 Proceso de Desarrollo

Configuración del Entorno

# Clonar el repositorio
git clone git@github.com:tu-usuario/git-multiaccount-windows-ssh.git

# Navegar al directorio
cd git-multiaccount-windows-ssh

# Copiar el archivo de ejemplo de configuración
copy env.example .env

# Editar .env con tus datos
notepad .env

Estructura del Proyecto

git-multiaccount-windows-ssh/
├── scripts/          # Scripts principales
├── hooks/            # Hooks de Git
├── lang/             # Archivos de internacionalización
├── README.md         # Documentación principal
├── CONTRIBUTING.md   # Esta guía
└── LICENSE          # Licencia MIT

📝 Estándares de Código

Scripts Batch (.bat)

  • Usar @echo off al inicio
  • Añadir chcp 65001 >nul para soporte UTF-8
  • Comentar bloques de código con REM
  • Usar nombres de variables descriptivos en MAYÚSCULAS
  • Validar entradas y manejar errores apropiadamente

Ejemplo:

@echo off
chcp 65001 >nul
setlocal EnableDelayedExpansion

REM === Descripción del script ===
set "VARIABLE_NAME=valor"

if not exist "archivo" (
    echo [ERROR] Mensaje descriptivo
    exit /b 1
)

echo [INFO] Operación exitosa
exit /b 0

Documentación

  • Documenta funciones complejas
  • Actualiza el README si añades nuevas características
  • Usa español para documentación principal
  • Incluye ejemplos de uso cuando sea relevante

Mensajes de Commit

Usa el formato:

tipo: descripción breve

Descripción detallada (opcional)

- Cambio 1
- Cambio 2

Tipos:

  • feat: Nueva funcionalidad
  • fix: Corrección de bug
  • docs: Cambios en documentación
  • refactor: Refactorización de código
  • test: Añadir o modificar tests
  • chore: Tareas de mantenimiento

Ejemplos:

feat: añadir soporte para Bitbucket

- Detectar hosts de Bitbucket
- Configurar identidad para Bitbucket
- Actualizar documentación

fix: corregir error de codificación en install-hooks

El script fallaba al ejecutar autosetidentity.bat
debido a problemas con UTF-8.

🐛 Reportar Bugs

Usa el template de issue para bugs:

**Descripción del Bug**
Descripción clara y concisa del problema.

**Pasos para Reproducir**
1. Ve a '...'
2. Ejecuta '...'
3. Observa el error

**Comportamiento Esperado**
Qué debería suceder.

**Comportamiento Actual**
Qué sucede actualmente.

**Entorno**
- OS: Windows 10/11
- Git Version: X.X.X
- PowerShell/CMD

**Screenshots/Logs**
Si aplica, añade capturas o logs.

💡 Sugerir Mejoras

Para sugerencias de mejora:

**¿Qué problema resuelve esta sugerencia?**
Descripción clara del problema.

**Solución Propuesta**
Cómo debería funcionar.

**Alternativas Consideradas**
Otras soluciones que consideraste.

**Contexto Adicional**
Cualquier información relevante.

✅ Checklist para Pull Requests

Antes de enviar tu PR, asegúrate de:

  • El código sigue los estándares del proyecto
  • Has añadido comentarios donde es necesario
  • Has actualizado la documentación (README, etc.)
  • Tus cambios no rompen funcionalidad existente
  • Has probado los scripts en Windows
  • Los mensajes de commit son descriptivos
  • Has referenciado issues relacionados (si aplica)

🙏 Agradecimientos

Cada contribución, por pequeña que sea, es valiosa. ¡Gracias por ayudar a mejorar este proyecto!

📞 Contacto

Si tienes preguntas sobre cómo contribuir, no dudes en:

  • Abrir un issue de discusión
  • Contactar a los mantenedores del proyecto

¡Feliz codificación! 🚀