Guía de Contribución a BairesCoding
¡Gracias por tu interés en contribuir a BairesCoding! 🎉
Este proyecto existe gracias a colaboradores como tú. Nuestro objetivo es crear herramientas de software libre de alta calidad que sirvan tanto a la comunidad como base para soluciones empresariales robustas. Para mantener este estándar, hemos establecido las siguientes pautas.
📋 ¿Cómo puedo contribuir?
1. Reportar Errores (Bugs)
Si encuentras un error, por favor crea un Issue siguiendo estos pasos:
- Busca primero: Revisa si el error ya fue reportado en los Issues.
- Usa la plantilla: Si es nuevo, abre un issue detallando:
- Pasos para reproducir el error.
- Comportamiento esperado vs. comportamiento real.
- Capturas de pantalla o logs (si aplica).
- Entorno (Sistema Operativo, versión del software, etc.).
2. Sugerir Nuevas Funcionalidades
¿Tienes una idea para mejorar una herramienta?
- Abre un Issue con la etiqueta
enhancement o feature request.
- Explica claramente el valor que aporta la funcionalidad y, si es posible, un caso de uso real.
- Importante: Espera a recibir feedback de los mantenedores antes de comenzar a escribir código, para asegurar que la idea se alinea con el propósito del proyecto.
3. Enviar Cambios (Pull Requests)
- Haz un Fork del repositorio y crea una rama (branch) para tu contribución.
- Usa nombres descriptivos:
fix/error-login, feat/exportacion-csv.
- Sigue el estilo de código: Mantén la coherencia con el código existente (indentación, nombrado de variables, etc.).
- Commit Messages: Usa el formato de Conventional Commits si es posible (ej:
fix: corrige error de validación en formulario).
- Pruebas: Si añades funcionalidad, asegúrate de que no rompa las pruebas existentes. Se valora mucho si incluyes nuevos tests.
- Documentación: Si tu cambio afecta al usuario final, actualiza el
README.md o la documentación correspondiente.
🛠 Estándares de Código
En BairesCoding valoramos la legibilidad y el mantenimiento a largo plazo:
- Clean Code: Priorizamos código limpio y auto-explicativo sobre soluciones “inteligentes” pero confusas.
- Idioma: El código (variables, funciones) debe estar preferentemente en inglés o español (dependiendo del repositorio específico), pero los comentarios y documentación deben ser claros.
- No subas credenciales: Asegúrate de no incluir contraseñas, tokens o claves privadas en tus commits.
⚖️ Aspectos Legales
Al contribuir a este repositorio, aceptas que tu código se publique bajo la misma licencia que el proyecto (generalmente MIT o Apache 2.0, ver archivo LICENSE en cada repositorio). Esto permite que el código siga siendo libre para la comunidad y utilizable en entornos comerciales.
¡Gracias por ayudar a construir mejor software! 🚀