diff --git a/source/es-ES/1.0.0/index.html.haml b/source/es-ES/1.0.0/index.html.haml index 0820afa..79ee28a 100644 --- a/source/es-ES/1.0.0/index.html.haml +++ b/source/es-ES/1.0.0/index.html.haml @@ -1,6 +1,6 @@ --- -description: Mantenga un Changelog -title: Mantenga un Changelog +description: Mantenga un changelog +title: Mantenga un changelog language: es-ES version: 1.0.0 --- @@ -18,8 +18,8 @@ version: 1.0.0 .header .title - %h1 Mantenga un Changelog - %h2 No dejes que tus amigos copien y peguen git logs en los CHANGELOGs™ + %h1 Mantenga un changelog + %h2 No dejes que tus amigos usen el registro de git en los changelogs. = link_to changelog do Versión @@ -33,21 +33,21 @@ version: 1.0.0 ¿Qué es un registro de cambios (changelog)? %p - Un registro de cambios o “changelog” de ahora en adelante, es un archivo que contiene una lista en orden cronológico sobre los cambios que vamos haciendo en cada release (o versión) de nuestro proyecto. + 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 para cada versión de un proyecto. %h3#why %a.anchor{ href: "#why", aria_hidden: "true" } - ¿Cuál es el propósito del changelog? + ¿Por qué mantener un changelog? %p - Que les sea más fácil a los usuarios y contribuyentes, ver exactamente los cambios notables que se han hecho entre cada versión (o versiones) del proyecto. + Para facilitar a los usuarios y colaboradores ver exactamente qué cambios reseñables se han realizados entre cada versión del proyecto. %h3#who %a.anchor{ href: "#who", aria_hidden: "true" } ¿Quién necesita un changelog? %p - Las personas. Ya sean consumidores o desarrolladores, los usuarios finales del software son seres humanos que les importa que hay en el software. Cuando el software cambia, la gente quiere saber el porqué y el cómo. + Las personas. Ya sean consumidores o desarrolladores, los usuarios finales del software son seres humanos a los que le importa lo que hay en el software. Cuando el software cambia, la gente quiere saber el porqué y el cómo. .good-practices %h3#how @@ -60,7 +60,7 @@ version: 1.0.0 %ul %li - Están hecho para los seres humanos, no para las máquinas. + Están hechos para los seres humanos, no para las máquinas. %li Debe haber una entrada para cada versión. %li @@ -68,11 +68,11 @@ version: 1.0.0 %li Versiones y secciones deben ser enlazables. %li - La última versión viene primero. + La última versión va primero. %li - La fecha de publicación de cada versión es mostrada. + Debe mostrar la fecha de publicación de cada versión. %li - Se menciona explícitamente si el proyecto sigue la convención del #{link_to "Versionamiento Semántico", semver}. + Indicar si el proyecto sigue el #{link_to "Versionamiento Semántico", semver}. %a.anchor{ href: "#types", aria_hidden: "true" } %h4#types Tipos de cambios @@ -86,13 +86,13 @@ version: 1.0.0 para los cambios en las funcionalidades existentes. %li %code Deprecated - para indicar que una característica está obsoleta y que se eliminará en las próximas versiones. + para indicar que una característica o funcionalidad está obsoleta y que se eliminará en las próximas versiones. %li %code Removed para las características en desuso que se eliminaron en esta versión. %li %code Fixed - para correcciones y bugs. + para corrección de errores. %li %code Security en caso de vulnerabilidades. @@ -101,61 +101,59 @@ version: 1.0.0 %h3#effort %a.anchor{ href: "#effort", aria_hidden: "true" } - ¿Cómo puedo minimizar el esfuerzo requerido? + ¿Cómo puedo minimizar el esfuerzo requerido para mantener el changelog? %p - Siempre mantén una sección con el nombre Unreleased para hacer un seguimiento sobre los próximos cambios. + Mantén una sección con el nombre Unreleased para hacer un seguimiento sobre los próximos cambios. %p Esto nos puede servir para dos cosas: %ul %li - La gente puede ver qué cambios podrían esperar en los próximos releases. + La gente puede ver qué cambios podrían esperar en los próximos lanzamientos. %li - Una vez que queramos hacer un release, sólo habría que mover la sección Unreleased y sus cambios en una nueva sección con la respectiva versión. + Al lanzar una nueva versión, tan sólo habría que mover el contenido de Unreleased a una sección para la nueva versión. .bad-practices %h3#bad-practices %a.anchor{ href: "#bad-practices", aria_hidden: "true" } ¿Pueden los changelogs ser malos? - %p Si. Aquí hay unas maneras en las que pueden ser muy poco útiles. + %p Sí. A continuación algunas formas en las que pueden ser muy poco útiles. %h4#log-diffs %a.anchor{ href: "#log-diffs", aria_hidden: "true" } Usar un diff de los logs de los commits %p - Usar un diff de los logs de los commits es una mala idea: están llenos de ruido. Cosas como hacer merge de los commits, commits con títulos oscuros, cambios de documentación, entre otros. + Usar un diff de los logs de los commits es una mala idea: están llenos de ruido. Cosas como hacer merge de los commits, commits con títulos poco claros, cambios de documentación, etc. %p - El propósito de un commit es documentar un paso en la evolución del código fuente. Algunos proyectos limpian los commits, en otros no. + El propósito de un commit es documentar un paso en la evolución del código fuente. Algunos proyectos limpian los commits, otros no. %p - El propósito de una entrada del changelog es documentar la notable diferencia, usualmente entre múltiples commits, para comunicarlos claramente a los usuarios finales. + El propósito de una entrada en el changelog es documentar cambios notables, usualmente entre múltiples commits, para comunicarlos claramente a los usuarios finales. %h4#ignoring-deprecations %a.anchor{ href: "#ignoring-deprecations", aria_hidden: "true" } - Ignorando Deprecaciones + Ignorar funcionalidades sin soporte %p - Cuando las personas actualizan de una versión a otra, debería ser extremadamente claro cuando algo se romperá. Debería ser posible actualizar a una versión que liste deprecaciones, remover qué está deprecado, luego actualizar a la versión donde las deprecaciones sean remociones. - + Cuando la gente actualiza de una version a otra, debería estar bastante claro cuándo algo se va a romper. Debería ser posible actualizar a una versión que detalle funcionalidades sin soporte, eliminar lo que está obsoleto y actualizar a la versión donde esas funcionalidades han sido eliminadas. %p - Si no haces nada más, lista deprecaciones, remociones, y cualquier cambio sin compatibilidad hacia atrás en tu changelog. - + Si no haces nada más, enumera lo que queda obsoleto, lo eliminado y cualquier otro cambio sin compatibilidad hacia atrás en tu changelog. %h4#confusing-dates %a.anchor{ href: "#confusing-dates", aria_hidden: "true" } Fechas confusas %p - En los EE.UU., la gente pone primero el mes (06-02-2012 para el 2 de junio del 2012), mientras que muchas personas en el resto del mundo escriben de una manera muy robótica 2 Junio 2012, sin embargo lo pronuncian distinto. 2012-06-02 funciona logicamente desde el más grande al más pequeño, no se solapa de maneras ambiugas con otros formatos de fecha, y es un #{link_to "Estandar ISO", iso}. Por lo cual, es el formato de fecha recomendado para changelogs. + En los EE.UU., la gente pone primero el mes (06-02-2012 para el 2 de junio del 2012), mientras que muchas personas en el resto del mundo escriben de una manera muy robótica 2 Junio 2012 aunque lo proununcien diferente. 2012-06-02 funciona logicamente desde el más grande al más pequeño, no se solapa de maneras ambiugas con otros formatos de fecha y es un #{link_to "Estándar ISO", iso}. Por lo cual, es el formato de fecha recomendado para el changelog. %aside Hay más. Ayúdame a recoger estos anti-patrones = link_to "abriendo un issue", "#issues" - o un pull request. + o una pull request. .frequently-asked-questions %h3#frequently-asked-questions @@ -164,14 +162,14 @@ version: 1.0.0 %h4#standard %a.anchor{ href: "#standard", aria_hidden: "true" } - ¿Hay un formato estándar para los changelogs? + ¿Hay un formato estándar para el changelog? %p - No realmente. Hay una guía de estilo del GNU, o los dos parrafos del archivo de NOTICIAS guideline del GNU. Ambos son inadecuados o insuficientes. + No. Hay una guía de estilo del GNU o los dos parrafos del archivo guideline del GNU NEWS. Ambos son inadecuados o insuficientes. %p Este proyecto apunta a ser - = link_to "una mejor convención de changelogs.", changelog + = link_to "una mejor convención de changelog.", changelog Esto se da observando las buenas prácticas en la comunidad open source y recopilando las mismas. %p @@ -188,44 +186,44 @@ version: 1.0.0 HISTORY, NEWS o RELEASES. %p - Si bien es fácil pensar que el nombre de tu archivo de changelog no importa tanto, ¿Por qué hacer dificil para los usuarios finales conseguir de manera consistente los cambios notables? + Si bien es fácil pensar que el nombre de tu archivo de changelog no importa tanto, ¿Por qué hacer difícil para los usuarios finales conseguir de manera consistente los cambios notables? %h4#github-releases %a.anchor{ href: "#github-releases", aria_hidden: "true" } ¿Y qué hay de los releases de Github? %p - Es una gran iniciativa. #{link_to "Los releases de Github", ghr} pueden ser utilizados para convertir simples etiquetas de git (por ejemplo una etiqueta llamada v1.0.0) en ricas notas de release ya sea añadiendo estas manualmente o trayendo los mensajes anotados de las etiquetas de git y convertirlas en notas. + Es una gran iniciativa. #{link_to "Los releases de Github", ghr} pueden ser utilizados para convertir simples etiquetas de git (por ejemplo una etiqueta llamada v1.0.0) en ricas notas de lanzamiento ya sea añadiendo estas manualmente o trayendo los mensajes anotados de las etiquetas de git y convertirlas en notas. %p - Los releases de Github crean un changelog no portable que solo pueden ser mostrados a usuarios dentro del contexto de Github. Es posible hacer que luzcan muy parecidas al formato de Mantenga un Changelog, pero tiende a ser un poco más involucrado. + 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 muy parecidas al formato de Mantenga un changelog, pero tiende a ser un poco más complicado. %p - 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 mayúsculas (README, CONTRIBUTING, entre otros.). Otro problema menor es que la interfaz actualmente no ofrece enlaces a los registros de los commits entre cada release. + 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 mayúsculas (README, CONTRIBUTING, etc.). Otro problema menor es que la interfaz actualmente no ofrece enlaces a los registros de los commits entre cada lanzamiento. %h4#automatic %a.anchor{ href: "#automatic", aria_hidden: "true" } ¿Se pueden analizar gramaticalmente los changelogs? %p - Es difícil, porque las personas siguen formatos y distintos nombres de archivo muy distintos. + Es difícil, porque las personas usan formatos y nombres de archivos muy distintos. %p #{link_to "Vandamme", vandamme} es una gema de Ruby creada por el equipo de - #{link_to "Gemnasium", gemnasium} y que analiza gramaticalmente muchos (pero no todos) los changelogs de proyectos open source. + #{link_to "Gemnasium", gemnasium} que analiza gramaticalmente muchos (pero no todos) los changelogs de proyectos open source. %h4#yanked %a.anchor{ href: "#yanked", aria_hidden: "true" } - ¿Qué hay sobre los releases retirados? + ¿Qué hay sobre las versiones retiradas? %p - "Yanked releases" son versiones que tuvieron que ser retiradas por un error grave o problema de seguridad. Con frecuencia estas versiones ni siquiera aparecen en los changelogs. Deberían. Así es como se deberían mostrarse: + «Yanked releases» son versiones que tuvieron que ser retiradas por un error grave o problema de seguridad. Con frecuencia estas versiones ni siquiera aparecen en los changelogs. Deberían. Así es como deberían mostrarse: %p ## 0.0.5 - 2014-12-13 [YANKED] %p - La etiqueta [YANKED] va entre corchetes por una razón, es importante que destaque, y el hecho de estar rodeado por corchetes lo hace más fácil de localizar programáticamente. + La etiqueta [YANKED] está destacada por una razón: es importante que destaque. El hecho de estar entre corchetes la hace también más fácil de localizar programáticamente. %h4#rewrite @@ -233,10 +231,10 @@ version: 1.0.0 ¿Deberías volver a escribir un changelog? %p - Por supuesto. Siempre hay buenas razones para mejorar el changelog. A veces abro "pull requests" para añadir registros faltantes en el changelog de proyectos open source. + Por supuesto. Siempre hay buenas razones para mejorar el changelog. A veces abro «pull requests» para añadir registros faltantes en el changelog de proyectos open source. %p - También es posible que puedas descubrir que olvidaste comentar sobre un cambio sin compatibilidad hacia atrás en las notas para una versión. En este caso es importante para ti actualizar el changelog. + También es posible que puedas descubrir que olvidaste señalar un cambio sin compatibilidad hacia atrás en las notas para una versión. En este caso es importante para ti actualizar el changelog. %h4#contribute @@ -244,7 +242,7 @@ version: 1.0.0 ¿Cómo puedo contribuir? %p - Este documento no es la verdad absoluta es mi cuidadosa opinión, junto con información y ejemplos que recogí. + Este documento no es la verdad absoluta; es mi cuidadosa opinión, junto con información y ejemplos que recopilé. %p Esto es porque quiero que la comunidad llegue a un consenso. Creo que la discusión es tan importante como el resultado final. @@ -255,4 +253,4 @@ version: 1.0.0 .press %h3 Conversaciones %p - Fuí al #{link_to "The Changelog podcast", thechangelog} para hablar acerca de porqué a los mantenedores y contribuidores deberían importarles los changelogs, y también acerca de las motivaciones detrás de este proyecto. + Fui a #{link_to "The Changelog podcast", thechangelog} para hablar acerca del porqué los mantenedores y colaboradores deberían preocuparse por los changelogs, y también acerca de las motivaciones detrás de este proyecto.