Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: ensure commit message format #427

Conversation

AlejandroSuero
Copy link
Contributor

@AlejandroSuero AlejandroSuero commented Mar 11, 2024

Descripción

He pensado que añadir un nuevo pre-hook para crear consistencia a la hora de escribir commits.

Problema solucionado

El formato de los commits no tiene una consistencia.

Ejemplo:

  • Añadir feature: feat: <your-commit-msg> o feat(<target>): <your-commit-msg>

Nota: serían por ejemplo: ui, components ...
Si se añade ! al final del verbo: feat(<target>)!: <your-commit-msg>, indica que son cambios que pueden producir rupturas (Breaking changes).

  • Corregir un error: fix: <your-commit-msg> o fix(#issue-number): <your-commit-msg>
  • Añadir documentación: docs: ...

Para más información Conventional commits

Cambios propuestos

  1. Asegurar que haya un formato y se siguen las normas de commit convencionales.

Capturas de pantalla (si corresponde)

Demo del GitHub oficial de commitlint:

Commitlint demo

Comprobación de cambios

  • He revisado que no haya ninguna PR (pull request) ya abierta con un problema similar, siguiendo el apartado de buenas prácticas
  • He revisado localmente los cambios para asegurarme de que no haya errores ni problemas.
  • He probado estos cambios en múltiples dispositivos y navegadores para asegurarme de que la landing page se vea y funcione correctamente.
  • He actualizado la documentación, si corresponde.

Impacto potencial

Una consistencia entre todos a la hora de crear commits

Contexto adicional

Enlaces útiles

Copy link

vercel bot commented Mar 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
la-velada-web-oficial ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 11, 2024 10:41pm

@AlejandroSuero
Copy link
Contributor Author

Se pueden añadir reglas para los commits de la siguiente manera.

// commitlint.config.cjs
module.exports = {
  extends: ["@commitlint/config-conventional"],
  rules: {
   "type-enum": [2, "always", ["[FIX]", "[FEATURE]", "añadir"]],
   // más normas
  }
}

Documentación para configuración.

@midudev
Copy link
Owner

midudev commented Mar 11, 2024

Gracias por la PR. Por ahora no vamos a añadir este tipo de control, ya que es bastante molesto si se hace commits a través de UI.

@midudev midudev closed this Mar 11, 2024
@AlejandroSuero
Copy link
Contributor Author

Gracias por la PR. Por ahora no vamos a añadir este tipo de control, ya que es bastante molesto si se hace commits a través de UI.

No sé exactamente a que te refieres con los problemas. Pregunto por saber el por qué podría fallar o no y como fallaría.

He probado tanto en Github Desktop como en VSCode como en terminal

Github Desktop:

  • Fallando:
Github Desktop failing
  • Pasando:
VSCode pasando

VScode:

  • Fallando
VSCode failing
  • Pasando
Screenshot 2024-03-12 at 01 16 37

También utilizo lazygit desde la terminal y puedes ver los outputs. Uso neovim y a veces uso un plugin que es vim-fugitive que es como una interfaz dentro del editor y tampoco me da problemas.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants