mirror of
https://github.com/olivierlacan/keep-a-changelog.git
synced 2025-07-29 16:54:12 +02:00
Fix lines length
In a previous commit I tried to apply the standard text mode (80 characters) to long lines, but something was wrong and they were bad formatted.
This commit is contained in:
parent
46ffb627fa
commit
cd377796ed
@ -34,8 +34,8 @@ version: 1.0.0
|
|||||||
|
|
||||||
%p
|
%p
|
||||||
Un registro de cambios, «changelog» de ahora en adelante, es un archivo que
|
Un registro de cambios, «changelog» de ahora en adelante, es un archivo que
|
||||||
contiene una lista cronológicamente ordenada de los cambios más destacables
|
contiene una lista cronológicamente ordenada de los cambios más destacables para
|
||||||
para cada versión de un proyecto.
|
cada versión de un proyecto.
|
||||||
|
|
||||||
%h3#why
|
%h3#why
|
||||||
%a.anchor{ href: "#why", aria_hidden: "true" }
|
%a.anchor{ href: "#why", aria_hidden: "true" }
|
||||||
@ -91,8 +91,8 @@ Cuando el software cambia, la gente quiere saber el porqué y el cómo.
|
|||||||
para los cambios en las funcionalidades existentes.
|
para los cambios en las funcionalidades existentes.
|
||||||
%li
|
%li
|
||||||
%code Deprecated
|
%code Deprecated
|
||||||
para indicar que una característica o funcionalidad está obsoleta y que
|
para indicar que una característica o funcionalidad está obsoleta y que se
|
||||||
se eliminará en las próximas versiones.
|
eliminará en las próximas versiones.
|
||||||
%li
|
%li
|
||||||
%code Removed
|
%code Removed
|
||||||
para las características en desuso que se eliminaron en esta versión.
|
para las características en desuso que se eliminaron en esta versión.
|
||||||
@ -117,7 +117,8 @@ seguimiento sobre los próximos cambios.
|
|||||||
|
|
||||||
%ul
|
%ul
|
||||||
%li
|
%li
|
||||||
La gente puede ver qué cambios podrían esperar en los próximos lanzamientos.
|
La gente puede ver qué cambios podrían esperar en los próximos
|
||||||
|
lanzamientos.
|
||||||
%li
|
%li
|
||||||
Al lanzar una nueva versión, tan sólo habría que mover el contenido de
|
Al lanzar una nueva versión, tan sólo habría que mover el contenido de
|
||||||
<code>Unreleased</code> a una sección para la nueva versión.
|
<code>Unreleased</code> a una sección para la nueva versión.
|
||||||
@ -165,15 +166,14 @@ cualquier otro cambio sin compatibilidad hacia atrás en tu changelog.
|
|||||||
Fechas confusas
|
Fechas confusas
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Los formatos de fecha regionales varían en todo el mundo y con
|
Los formatos de fecha regionales varían en todo el mundo y con frecuencia es
|
||||||
frecuencia es difícil encontrar un formato intuitivo para todos. La
|
difícil encontrar un formato intuitivo para todos. La ventaja de las fechas con
|
||||||
ventaja de las fechas con el formato <code>2017-07-17</code> es que
|
el formato <code>2017-07-17</code> es que siguen un orden de unidades de mayor a
|
||||||
siguen un orden de unidades de mayor a menor: año, mes y día. Este
|
menor: año, mes y día. Este formato tampoco coincide de forma ambigua con otros
|
||||||
formato tampoco coincide de forma ambigua con otros formatos de fecha,
|
formatos de fecha, a diferencia de algunos que intercambian la posición del mes
|
||||||
a diferencia de algunos que intercambian la posición del mes y el día.
|
y el día. Todo esto, junto al hecho de ser un #{link_to "estándar ISO", iso},
|
||||||
Todo esto, junto al hecho de ser un #{link_to "estándar ISO", iso}, son
|
son los motivos por los que es el formato de fecha recomendado para las entradas
|
||||||
los motivos por los que es el formato de fecha recomendado para las
|
del changelog.
|
||||||
entradas del changelog.
|
|
||||||
|
|
||||||
%aside
|
%aside
|
||||||
Hay más. Ayúdame a recoger estos anti-patrones
|
Hay más. Ayúdame a recoger estos anti-patrones
|
||||||
@ -211,7 +211,7 @@ recopilando las mismas.
|
|||||||
|
|
||||||
%p
|
%p
|
||||||
Llámalo <code>CHANGELOG.md</code>. Algunos proyectos utilizan
|
Llámalo <code>CHANGELOG.md</code>. Algunos proyectos utilizan
|
||||||
<code>HISTORY</code>, <code>NEWS</code> o <code>RELEASES</code>.
|
<code>HISTORY</code>, <code>NEWS</code> o <code>RELEASES</code>.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
Si bien es fácil pensar que el nombre de tu archivo de changelog no importa
|
Si bien es fácil pensar que el nombre de tu archivo de changelog no importa
|
||||||
@ -232,15 +232,15 @@ convertirlas en notas.
|
|||||||
%p
|
%p
|
||||||
Los releases de Github crean un changelog no portable que sólo pueden ser
|
Los releases de Github crean un changelog no portable que sólo pueden ser
|
||||||
mostrados a usuarios dentro del contexto de Github. Es posible hacer que luzcan
|
mostrados a usuarios dentro del contexto de Github. Es posible hacer que luzcan
|
||||||
muy parecidas al formato de <em>Mantenga un changelog</em>, pero tiende a ser
|
muy parecidas al formato de <em>Mantenga un changelog</em>, pero tiende a ser un
|
||||||
un poco más complicado.
|
poco más complicado.
|
||||||
|
|
||||||
%p
|
%p
|
||||||
La versión actual de los releases de Github es también discutiblemente no
|
La versión actual de los releases de Github es también discutiblemente no
|
||||||
muy detectable por los usuarios finales, diferente a los típicos archivos en
|
muy detectable por los usuarios finales, diferente a los típicos archivos en
|
||||||
mayúsculas (<code>README</code>, <code>CONTRIBUTING</code>, etc.). Otro
|
mayúsculas (<code>README</code>, <code>CONTRIBUTING</code>, etc.). Otro problema
|
||||||
problema menor es que la interfaz actualmente no ofrece enlaces a los registros
|
menor es que la interfaz actualmente no ofrece enlaces a los registros de los
|
||||||
de los commits entre cada lanzamiento.
|
commits entre cada lanzamiento.
|
||||||
|
|
||||||
%h4#automatic
|
%h4#automatic
|
||||||
%a.anchor{ href: "#automatic", aria_hidden: "true" }
|
%a.anchor{ href: "#automatic", aria_hidden: "true" }
|
||||||
|
Loading…
x
Reference in New Issue
Block a user