|
| 1 | +# 🤝 Guia de Contribucion |
| 2 | + |
| 3 | +Gracias por contribuir a este proyecto. |
| 4 | + |
| 5 | +## 🔒 Regla principal |
| 6 | + |
| 7 | +La rama `main` esta protegida. |
| 8 | + |
| 9 | +No se permiten pushes directos a `main`. |
| 10 | +Todos los cambios deben entrar por Pull Request. |
| 11 | + |
| 12 | +## 🌿 Flujo de trabajo obligatorio |
| 13 | + |
| 14 | +1. Actualiza tu rama local principal: |
| 15 | + |
| 16 | +```bash |
| 17 | +git checkout main |
| 18 | +git pull |
| 19 | +``` |
| 20 | + |
| 21 | +2. Crea una rama para tu cambio: |
| 22 | + |
| 23 | +```bash |
| 24 | +git checkout -b tipo/descripcion-corta |
| 25 | +``` |
| 26 | + |
| 27 | +Ejemplos de prefijo: |
| 28 | + |
| 29 | +- `feat/` para funcionalidad nueva |
| 30 | +- `fix/` para correccion de errores |
| 31 | +- `docs/` para documentacion |
| 32 | +- `chore/` para tareas de mantenimiento |
| 33 | + |
| 34 | +3. Realiza tus cambios y confirma con mensajes claros: |
| 35 | + |
| 36 | +```bash |
| 37 | +git add . |
| 38 | +git commit -m "tipo: descripcion breve" |
| 39 | +``` |
| 40 | + |
| 41 | +4. Sube la rama y crea Pull Request: |
| 42 | + |
| 43 | +```bash |
| 44 | +git push -u origin tipo/descripcion-corta |
| 45 | +``` |
| 46 | + |
| 47 | +5. Espera validaciones: |
| 48 | + |
| 49 | +- CI en verde |
| 50 | +- Al menos 1 aprobacion |
| 51 | +- Conversaciones resueltas |
| 52 | + |
| 53 | +6. Mergea el PR cuando cumpla todo lo anterior. |
| 54 | + |
| 55 | +## ✅ Checklist para PR |
| 56 | + |
| 57 | +- [ ] El cambio esta enfocado y no mezcla temas |
| 58 | +- [ ] README o docs actualizados si aplica |
| 59 | +- [ ] Variables de entorno documentadas si cambian |
| 60 | +- [ ] CI pasa correctamente |
| 61 | + |
| 62 | +## 🧪 Pruebas recomendadas antes de abrir PR |
| 63 | + |
| 64 | +Backend: |
| 65 | + |
| 66 | +```bash |
| 67 | +cd backend |
| 68 | +./mvnw -DskipTests compile |
| 69 | +``` |
| 70 | + |
| 71 | +Frontend: |
| 72 | + |
| 73 | +```bash |
| 74 | +cd frontend |
| 75 | +npm run build |
| 76 | +``` |
| 77 | + |
| 78 | +## 📝 Convencion de commits sugerida |
| 79 | + |
| 80 | +- `feat: ...` |
| 81 | +- `fix: ...` |
| 82 | +- `docs: ...` |
| 83 | +- `refactor: ...` |
| 84 | +- `chore: ...` |
| 85 | + |
| 86 | +## 🙌 Gracias |
| 87 | + |
| 88 | +Cada PR que mejora estabilidad, claridad o experiencia de uso suma mucho al proyecto. |
0 commit comments