Joomla

Lineamientos sobre Compromisos (Commit)

From Joomla! Documentation

This page is a translated version of the page Joomla:Commit Guidelines and the translation is 100% complete.

Other languages:
English • ‎español • ‎français

Lineamientos sobre Compromisos para el CMS de Joomla!.

Estas directrices no son reglas estrictas, sino una guía para lo que se consideran las mejores prácticas.

Combinar-Comprometer vs Aplastar

Combinar-Comprometer

Cuando hagad clic en el botón "Merge" en GitHub, se creará una combinación-compromiso llamado "Merge pull request #1234 from User/Branch". Este compromiso se muestra junto con todos los compromisos en el PR en el registro. Cada compromiso tendrá la fecha original de cuando fue creado, no cuando en realidad fue fusionado. Mientras que esto es bueno para preservar la real historia del compromiso y está muy bien parra los Clientes Git que muestran las ramas, se convierte en ilegible especialmente en la págian de registro de GitHub.

Aplastar

Cuando se aplasta el compromiso, se crea un único compromiso que consta de todos los compromisos originales. Este único compromiso es empujado al master y puede ser nombrado de una forma estandarizada.

Recomendación

Recomendamos aplastar los compromisos en la mayoría de los casos. El "Merge" que se encuentra en GitHub sólo debe ser utilizado para PRs simples con sólo un par de compromisos y cuando tiene sólo unos pocos días de vida. La mayor parte del tiempo, este es el caso de PRs simples para tratar con estilo de código o cadenas de idioma.

Convenciones De Nomenclatura

Cuando se aplaste el compromiso, uno debe seguir estas convenciones de nomenclatura para que el registro será más fácil de leer.

Formato

<[Prefix]> <Title>. <Issue>
<Description>

Prefijos

Prefijo Significado
sec Seguridad
bug Corrección de errores
add Agregar
rem Quitar
lang Idioma
doc Documentación / Notas
imp Mejora
tests Pruebas

Un compromiso puede tener varios prefijos. Si ese es el caso, cada uno va entre sus propios corchetes.

Título

Utiliza un título descriptivo para el compromiso. Generalmente el título de la PR va a estar bien.

Asunto

Después del título que agregar un punto, seguido por un texto como "Closes #1234". Esto cerrará automáticamente la PR, cuando el compromiso es empujado al frente y también proporciona un enlace al PR. Ver https://help.github.com/articles/closing-issues-via-commit-messages para las palabras clave disponibles.

Descripción

La descripción es opcional. Puede contener información adicional al compromiso. Por lo general esto no es necesario ya que la información está disponible en los enlaces de Pull Request.

Ejemplo

[lng] Clarify content smart search plugins. Closes #1833