Mejora tus mensajes de commit con GitHub Copilot en VSCode

Written by

in

,

GitHub Copilot permite configurar instrucciones personalizadas para la generación de mensajes de commit. Solo necesitas crear un archivo con las reglas que quieres que siga y decirle a VSCode dónde encontrarlo.

Paso 1: Crear el archivo de instrucciones

En la raíz de tu proyecto, crea la carpeta .vscode si no existe, y dentro de ella un archivo llamado copilot-commit-message-instructions.md

Este es el contenido que yo configuré:

# Instrucciones para mensajes de commit

- Escribe siempre los mensajes en español.
- Usa verbo en imperativo y describe el cambio principal con claridad.
- Mantén la primera línea breve y específica.
- Luego del tipo, indica el módulo o área del proyecto entre paréntesis.
- Después de los dos puntos, escribe una breve descripción del cambio en minúscula y sin punto final.
- Si aplica, incluye el alcance del cambio (por ejemplo: auth, productos, bags, tests).
- Evita mensajes genéricos como "cambios varios" o "fix" sin contexto.

## Formato recomendado

`<tipo>(<alcance>): <resumen en español>`

Reglas del resumen:

- En español.
- Siempre en modo imperativo.
- Inicia con minúscula.
- No termina con punto.

Tipos sugeridos: `feat`, `fix`, `refactor`, `test`, `docs`, `chore`, `style`, `perf`, `ci`, `build`.

## Ejemplos

- feat(auth): agrega funcionalidad de inicio de sesión con Google
- fix(api): corrige error en la validación de datos de entrada
- docs(readme): actualiza sección de instalación
- style(css): mejora la legibilidad del código eliminando espacios innecesarios
- refactor(user): optimiza la función de actualización de perfil
- test(order): prueba la función de cálculo de total de la orden
- chore(deps): actualiza dependencias a sus últimas versiones
- perf(database): mejora el rendimiento de las consultas a la base de datos
- ci(github-actions): agrega workflow para pruebas automatizadas

Paso 2: Configurar VSCode para usar las instrucciones

Ahora necesitamos decirle a VSCode que use este archivo cuando Copilot genere sugerencias de commits. Para ello, edita (o crea) el archivo `.vscode/settings.json` con el siguiente contenido:

{
    "github.copilot.chat.commitMessageGeneration.instructions": [
        {
            "file": ".vscode/copilot-commit-message-instructions.md"
        }
    ]
}

¡Y eso es todo! La próxima vez que vayas a hacer un commit, Copilot generará sugerencias siguiendo estas reglas.

Subscribe
Notify of
guest

This site uses Akismet to reduce spam. Learn how your comment data is processed.

0 Comments
Oldest
Newest Most Voted
Inline Feedbacks
View all comments