Reglas Universales

Cómo Escribir Mensajes de Commit Efectivos

Nuestro objetivo es comunicar de forma clara qué se hizo y por qué, facilitando la revisión y colaboración.

Los mensajes de los commits debe seguir ciertas reglas:

• Mensaje en inglés y en modo imperativo.
• Máximo 72 caracteres en el título
• Cuerpo opcional para explicar el “qué” y “por qué”
• Commits: Usar prefijos semanticos(feat:, fix:,docs:)

Ejemplos

• feat: add new search feature
• docs: update getting started documentation

Para mas informacion sobre los mensajes de commit, puedes consultar commit-message.

Cómo Gestionar la Estrategia de Ramas (Branching Strategy)

Para mantener un flujo de trabajo ordenado y eficiente, se recomienda seguir una estrategia de ramas.

1. Utilizamos ramas principales para entornos de producción.
   • Ramas principales:
     • main protegida (produccion).
     • dev rama para la integracion de los cambios.
2. Crea ramas de trabajo específicas: - feature/nombre-descriptivo nuevas funcionalidades (ej:feature/user-auth) - bug-fix/issue: correciones criticas. - hot-fix/issue: correcciones en producciones.

Cómo Crear un PR o Pull Request

Requisitos al hacer un PR

1. Redacta una descripción clara que detalle el contexto y el propósito de los cambios.
2. Incluye capturas de pantalla u otros elementos visuales si son relevantes.
3. Solicita al menos una aprobación de otro desarrollador.
4. Verifica que todos los tests se ejecuten y pasen correctamente.

Consejos adicionales:

• Divide los cambios extensos en PRs más pequeños y manejables.
• Crea la PR desde una rama de trabajo, nunca directamente a la rama principal.
• Evita incluir cambios de formateo en el mismo PR para reducir el ruido durante la revisión.

Para mas informacion sobre los PR, puedes consultar Contribution

Cómo Estructurar la Documentación del Proyecto

Cada proyecto deber tener un README.md

1. Crea un archivo README.md en la raíz del proyecto.
2. Comienza con el nombre del proyecto y una breve descripción de su propósito y alcance.
3. Describe los pasos de instalación, incluyendo:
   • Requisitos (por ejemplo, versiones de Java, Node, etc.).
   • Comandos necesarios para clonar el repositorio y para instalar dependencias.
4. Especifica la configuración del proyecto, como las variables de entorno y ejemplos de código.

# Nombre del Proyecto
Breve descripción del propósito y alcance.

## 🚀 Instalación
1. Requisitos: Java 21+, Node 18.
2. Clonar repositorio: `git clone https://github.com/startup/project.git`
3. Instalar dependencias: `mvn clean install`

## ⚙️ Configuración
- Variables de entorno:
  DB_URL=jdbc:postgresql://localhost:5432/db
  API_KEY=your_key_here