mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2024-11-15 02:45:15 +01:00
feat(lang): v1.0.0-beta.2 spanish translation
This commit is contained in:
Mauricio Robayo
Damiano Petrungaro
parent
b90d8e1596
commit
432a6fef43
@ -8,6 +8,7 @@ languages:
|
|||||||
pl: polish
|
pl: polish
|
||||||
it: italian
|
it: italian
|
||||||
zh-Hans: 简体中文
|
zh-Hans: 简体中文
|
||||||
|
es: spanish
|
||||||
|
|
||||||
versions:
|
versions:
|
||||||
- 1.0.0-beta
|
- 1.0.0-beta
|
||||||
|
|||||||
288
lang/es/index.md
288
lang/es/index.md
@ -1,163 +1,249 @@
|
|||||||
---
|
---
|
||||||
title: Conventional Commits 1.0.0-beta.1
|
title: Commits Convencionales 1.0.0-beta.2
|
||||||
language: es
|
language: es
|
||||||
---
|
---
|
||||||
|
|
||||||
# Conventional Commits 1.0.0-beta.1
|
# Commits Convencionales 1.0.0-beta.2
|
||||||
|
|
||||||
## Summary
|
## Resumen
|
||||||
|
|
||||||
As an open-source maintainer, squash feature branches onto `master` and write
|
Al mantener proyectos de código abierto, cuando se incorporan ramas con nuevas
|
||||||
a standardized commit message while doing so.
|
características en `master` al escribir un mensaje de commit estandarizado, el
|
||||||
|
mensaje del commit debe estar estructurado de la siguiente forma:
|
||||||
The commit message should be structured as follows:
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
```
|
```
|
||||||
<type>[optional scope]: <description>
|
<tipo>[ámbito opcional]: <descripción>
|
||||||
|
|
||||||
[optional body]
|
[cuerpo opcional]
|
||||||
|
|
||||||
[optional footer]
|
[nota de pie opcional]
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
<br />
|
<br />
|
||||||
The commit contains the following structural elements, to communicate intent to the
|
El commit contiene los siguientes elementos estructurales para comunicar la
|
||||||
consumers of your library:
|
intención al consumidor de la librería:
|
||||||
|
|
||||||
1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with [`PATCH`](http://semver.org/#summary) in semantic versioning).
|
1. **fix:** un commit de _tipo_ `fix` corrige un error en la base del código
|
||||||
2. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates
|
(se correlaciona con [`PATCH`](http://semver.org/#summary) en el versionado
|
||||||
with [`MINOR`](http://semver.org/#summary) in semantic versioning).
|
semántico).
|
||||||
3. **BREAKING CHANGE:** a commit that has the text `BREAKING CHANGE:` at the beginning of its optional body or footer section introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). A breaking change can be
|
2. **feat:** un commit de _tipo_ `feat` introduce nuevas características en la
|
||||||
part of commits of any _type_. e.g., a `fix:`, `feat:` & `chore:` types would all be valid, in addition to any other _type_.
|
base del código (se correlaciona con [`MINOR`](http://semver.org/#summary)
|
||||||
|
en el versionado semántico).
|
||||||
|
3. **BREAKING CHANGE:** un commit que contiene el texto `BREAKING CHANGE:` al
|
||||||
|
inicio de su cuerpo opcional o la sección de nota de pie introduce un cambio
|
||||||
|
en el uso de la API (se correlaciona con [`MAJOR`](http://semver.org/#summary)
|
||||||
|
en el versionado semántico). Un cambio en el uso de la API puede ser parte
|
||||||
|
de commits de _tipo_. e.g., a `fix:`, `feat:` & `chore:` todos tipos
|
||||||
|
válidos, adicional a cualquier otro _tipo_.
|
||||||
|
4. Otros: _tipos_ de commits distintos a `fix:` y `feat:` están permitidos, por
|
||||||
|
ejemplo [commitlint-config-conventional](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional)
|
||||||
|
(basado en [the Angular convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit))
|
||||||
|
recomienda `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:` y
|
||||||
|
otros. También recomendamos `improvement` para commits que mejorar una
|
||||||
|
implementación actual sin añadir nuevas características ni corregir errores.
|
||||||
|
Tenga presente que estos tipos no son impuestos por la especificación de
|
||||||
|
commits convencionales y no tienen efecto implícito en el versionado
|
||||||
|
semántico (a menos que incluyan el texto BREAKING CHANGE, lo cual NO es
|
||||||
|
recomendado).
|
||||||
|
<br />
|
||||||
|
Se puede agregar un ámbito al _tipo_ de commit para proveer información
|
||||||
|
contextual adicional y se escribe entre paréntesis, e.g., `feat(parser): add ability to parse arrays`.
|
||||||
|
|
||||||
<br />
|
## Ejemplos
|
||||||
A scope may be provided to a commit's type, to provide additional contextual information and
|
|
||||||
is contained within parenthesis, e.g., `feat(parser): adds ability to parse arrays`.
|
|
||||||
|
|
||||||
Commit _types_ other than `fix:` and `feat:` are allowed, for example [the Angular convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) recommends `docs:`, `style:`, `refactor:`, `perf:`, `test:`, `chore:`, but these tags are
|
### Mensaje de commit con descripción y cambio en el uso de la API en el cuerpo
|
||||||
not mandated by the conventional commits specification.
|
|
||||||
|
|
||||||
## Introduction
|
```
|
||||||
|
feat: allow provided config object to extend other configs
|
||||||
|
|
||||||
In software development, it's been my experience that bugs are most often introduced
|
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
|
||||||
at the boundaries between applications. Unit testing works great for testing the interactions
|
```
|
||||||
that an open-source maintainer knows about, but do a poor job of capturing all the
|
|
||||||
interesting, often unexpected, ways that a community puts a library to use.
|
|
||||||
|
|
||||||
Anyone who has upgraded to a new patch version of a dependency, only to watch their
|
### Mensaje de commit sin cuerpo
|
||||||
application start throwing a steady stream of 500 errors, knows how important
|
|
||||||
a readable commit history (and [ideally a well maintained CHANGELOG](http://keepachangelog.com/en/0.3.0/)) is to the ensuing
|
|
||||||
forensic process.
|
|
||||||
|
|
||||||
The Conventional Commits specification proposes introducing a standardized lightweight
|
```
|
||||||
convention on top of commit messages. This convention dovetails with [SemVer](http://semver.org),
|
docs: correct spelling of CHANGELOG
|
||||||
asking software developers to describe in commit messages, features, fixes, and breaking
|
```
|
||||||
changes that they make.
|
|
||||||
|
|
||||||
By introducing this convention, we create a common language that makes it easier to
|
### Mensaje de commit con ámbito
|
||||||
debug issues across project boundaries.
|
|
||||||
|
|
||||||
## Conventional Commits Specification
|
```
|
||||||
|
feat(lang): added polish language
|
||||||
|
```
|
||||||
|
|
||||||
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
|
### Mensaje de commit para una corrección usando un número de problema (opcional)
|
||||||
|
|
||||||
1. commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc.,
|
```
|
||||||
followed by a colon and a space.
|
fix: minor typos in code
|
||||||
2. the type `feat` MUST be used when a commit adds a new feature to your application
|
|
||||||
or library.
|
|
||||||
3. the type `fix` MUST be used when a commit represents a bug fix for your application.
|
|
||||||
4. an optional scope MAY be provided after a type. A scope is a phrase describing
|
|
||||||
a section of the codebase enclosed in parenthesis, e.g., `fix(parser):`
|
|
||||||
5. A description MUST immediately follow the type/scope prefix.
|
|
||||||
The description is a short description of the pull request, e.g.,
|
|
||||||
_fix: array parsing issue when multiple spaces were contained in string._
|
|
||||||
6. A longer commit body MAY be provided after the short description. The body MUST
|
|
||||||
begin one blank line after the description.
|
|
||||||
7. A footer MAY be provided one blank line after the body. The footer SHOULD contain
|
|
||||||
additional meta-information about the pull-request (such as the issues it fixes, e.g., `fixes #13, #5`).
|
|
||||||
8. Breaking changes MUST be indicated at the very beginning of the footer or body section of a commit. A breaking change MUST consist of the uppercase text `BREAKING CHANGE`, followed by a colon and a space.
|
|
||||||
9. A description MUST be provided after the `BREAKING CHANGE: `, describing what
|
|
||||||
has changed about the API, e.g., _BREAKING CHANGE: environment variables now take precedence over config files._
|
|
||||||
10. types other than `feat` and `fix` MAY be used in your commit messages.
|
|
||||||
|
|
||||||
## Why Use Conventional Commits
|
see the issue for details on the typos fixed
|
||||||
|
|
||||||
* Automatically generating CHANGELOGs.
|
fixes issue #12
|
||||||
* Automatically determining a semantic version bump (based on the types of commits landed).
|
```
|
||||||
* Communicating the nature of changes to teammates, the public, and other stakeholders.
|
|
||||||
* Triggering build and publish processes.
|
## Introducción
|
||||||
* Making it easier for people to contribute to your projects, by allowing them to explore
|
|
||||||
a more structured commit history.
|
En el desarrollo de software, ha sido mi experiencia que los errores en el
|
||||||
|
código son introducidos con más frecuencia en las fronteras de la aplicación.
|
||||||
|
Los tests unitarios funcionan muy bien para probar las interacciones que el
|
||||||
|
mantenedor conoce, pero hacen un mal trabajo capturando la manera interesante,
|
||||||
|
a veces inesperada, en que una comunidad usa una librería.
|
||||||
|
|
||||||
|
Cualquiera que haya actualizado una versión corregida de una dependencia para
|
||||||
|
luego darse cuenta de que la aplicación empieza a arrojar un flujo de 500
|
||||||
|
errores, sabe lo importante que es un historial de commits legible (e
|
||||||
|
[idealmente un bien mantenido CHANGELOG](http://keepachangelog.com/en/0.3.0/))
|
||||||
|
para el consiguiente proceso forense.
|
||||||
|
|
||||||
|
La especificación de Commits Convencionales propone introducir una convención
|
||||||
|
estandarizada y ligera sobre los mensajes de los commits. Esta convención encaja
|
||||||
|
con [SemVer](http://semver.org), pidiéndole a los desarrolladores de software
|
||||||
|
describir en los mensajes de los commits, las características, correcciones y
|
||||||
|
cambios que rompen el uso de la API que hagan.
|
||||||
|
|
||||||
|
Al introducir esta convención, creamos un lenguaje común que permite depurar más
|
||||||
|
fácilmente los problemas a través de las fronteras de un proyecto.
|
||||||
|
|
||||||
|
## Especificación de Commits Convencionales
|
||||||
|
|
||||||
|
Las palabras “DEBE” (“MUST”), “NO DEBE” (“MUST NOT”), “REQUIERE” (“REQUIRED”),
|
||||||
|
“DEBERÁ” (“SHALL”), “NO DEBERÁ” (“SHALL NOT”), “DEBERÍA” (“SHOULD”),
|
||||||
|
“NO DEBERÍA” (“SHOULD NOT”), “RECOMIENDA” (“RECOMMENDED”), “PUEDE” (“MAY”) Y
|
||||||
|
“OPCIONAL” (“OPTIONAL”) en este documento se deben interpretar como se describe
|
||||||
|
en [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
|
||||||
|
|
||||||
|
1. Los commits DEBEN iniciar con un tipo que consiste en un sustantivo `feat`, `fix`, etc.,
|
||||||
|
seguido de dos puntos y un espacio.
|
||||||
|
2. El tipo `feat` DEBE ser usado cuando un commit agrega una nueva
|
||||||
|
característica a la aplicación o librería.
|
||||||
|
3. El tipo `fix` DEBE ser usado cuando el commit representa una corrección a un
|
||||||
|
error en el código de la aplicación.
|
||||||
|
4. Se PUEDE añadir un ámbito opcional después del tipo. El ámbito es una frase
|
||||||
|
que describe una sección de la base del código encerrada en paréntesis,
|
||||||
|
e.g., `fix(parser):`
|
||||||
|
5. Una descripción DEBE ir inmediatamente después del tipo/ámbito inicial y es
|
||||||
|
una descripción corta de los cambios realizados en el código, e.g.,
|
||||||
|
_fix: array parsing issue when multiple spaces were contained in string._
|
||||||
|
6. Un cuerpo del commit más extenso PUEDE agregarse después de la descripción,
|
||||||
|
dando información contextual adicional acerca de los cambios en el código.
|
||||||
|
El cuerpo DEBE iniciar con una línea en blanco después de la descripción.
|
||||||
|
7. Una nota de pie PUEDE agregarse tras una línea en blanco después del
|
||||||
|
cuerpo o después de la descripción en caso de que no se haya dado un cuerpo.
|
||||||
|
La nota de pie DEBE contener referencias adicionales a los números de
|
||||||
|
problemas registrados sobre el cambio del código (como el número de problema
|
||||||
|
que corrige, e.g.,`Fixes #13`).
|
||||||
|
8. Los cambios que rompen la API DEBEN ser indicados al inicio de la nota de
|
||||||
|
pie o el cuerpo del commit. Un cambio que rompe la API DEBE contener el
|
||||||
|
texto en mayúsculas `BREAKING CHANGE`, seguido de dos puntos y espacio.
|
||||||
|
9. Una descripción se DEBE proveer después de `BREAKING CHANGE:`, describiendo
|
||||||
|
qué ha cambiado en la API, e.g., _BREAKING CHANGE: environment variables now take precedence over config files._
|
||||||
|
10. La nota de pie DEBE contener solamente el texto `BREAKING CHANGE`, vínculos
|
||||||
|
externos, referencias a problemas u otra metainformación.
|
||||||
|
11. Otros tipos distintos a `feat` y `fix` PUEDEN ser usados en los mensajes de
|
||||||
|
los commits.
|
||||||
|
|
||||||
|
## ¿Por qué usar Commits Convencionales?
|
||||||
|
|
||||||
|
* Generación automática de CHANGELOGs.
|
||||||
|
* Determinación automática de los cambios de versión (basado en los tipos de
|
||||||
|
commits).
|
||||||
|
* Comunicar la naturaleza de los cambios a los demás integrantes del equipo, el
|
||||||
|
público o cualquier otro interesado.
|
||||||
|
* Ejecutar procesos de ejecución y publicación.
|
||||||
|
* Hacer más fácil a otras personas contribuir al proyecto, permitiendo explorar
|
||||||
|
una historia de los commits más estructurada.
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
### How should I deal with commit messages in the initial development phase?
|
### ¿Cómo puedo trabajar con los mensajes de los commits en la etapa inicial de desarrollo?
|
||||||
|
|
||||||
We recommend that you proceed as if you've an already released product. Typically *somebody*, even if its your fellow software developers, is using your software. They'll want to know what's fixed, what breaks etc.
|
Recomendamos trabajar como si ya hubiera lanzado su producto. Típicamente
|
||||||
|
_alguien_, incluso si son sus compañeros desarrolladores, están usando su
|
||||||
|
producto. Ellos querrán saber que se ha arreglado, que se ha dañado, etc.
|
||||||
|
|
||||||
### What do I do if the commit conforms to more than one of the commit types?
|
### ¿Qué debo hacer si un commit encaja en más de un tipo de commit?
|
||||||
|
|
||||||
Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.
|
Regrese y haga múltiples commits de ser posible. Parte de los beneficios de los
|
||||||
|
Commits Convencionales es la habilidad para hacer commits más organizados y así
|
||||||
|
mismo PRs.
|
||||||
|
|
||||||
### Doesn’t this discourage rapid development and fast iteration?
|
### ¿No desalienta esto el desarrollo y la iteración rápida?
|
||||||
|
|
||||||
It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors.
|
Desalienta moverse rápido de una forma desorganizada. Ayuda a moverse rápido a
|
||||||
|
largo plazo a través de proyectos con una gran variedad de contribuidores.
|
||||||
|
|
||||||
### Might Conventional Commits lead developers to limit the type of commits they make because they'll be thinking in the types provided?
|
### ¿Pueden los Commits Convencionales llevar a los desarrolladores a limitar el tipo de commits que hacen ya que estarán pensando en los tipos previstos?
|
||||||
|
|
||||||
Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time.
|
Los Commits Convencionales nos animan a hacer más de cierto tipo de commits como
|
||||||
|
_fixes_. Adicionalmente, la flexibilidad de los Commits Convencionales permite
|
||||||
|
a su equipo generar sus propios tipos y cambiarlos a lo largo del tiempo.
|
||||||
|
|
||||||
### How does this relate to SemVer?
|
### ¿Cómo se relaciona esto con SemVer?
|
||||||
|
|
||||||
`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases.
|
El tipo de commit `fix` se traduce a un cambio de versión `PATCH`. El tipo de
|
||||||
|
commit `feat` se traduce a un cambio de versión `MINOR`. Commits con el texto
|
||||||
|
`BREAKING CHANGE`, sin importar su tipo, se traducen a un cambio de versión
|
||||||
|
`MAJOR`.
|
||||||
|
|
||||||
### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`?
|
### ¿Cómo puedo versionar mis extensiones a la especificación de Commits Convencionales, e.g. `@jameswomack/conventional-commit-spec`?
|
||||||
|
|
||||||
We recommend using SemVer to release your own extensions to this specification (and
|
Recomendamos usar SemVer para liberar su propia extensión a esta especificación
|
||||||
encourage you to make these extensions!)
|
(¡y lo animamos a hacer esta extensión!)
|
||||||
|
|
||||||
### What do I do if I accidentally use the wrong commit type?
|
### ¿Qué debo hacer si por accidente uso un tipo de commit equivocado?
|
||||||
|
|
||||||
#### When you used a type that's of the spec but not the correct type, e.g. `fix` instead of `feat`
|
#### Cuando utiliza un tipo que es de la especificación pero no es el correcto, e.g. `fix` en lugar de `feat`
|
||||||
|
|
||||||
Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use.
|
Antes de combinar o liberar el error, recomendamos usar `git rebase -i` para
|
||||||
|
editar la historia de los commits. Después de que se ha liberado, la limpieza
|
||||||
|
será distinta de acuerdo con las herramientas y procesos que usted use.
|
||||||
|
|
||||||
#### When you used a type *not* of the spec, e.g. `feet` instead of `feat`
|
#### Cuanto se usa un tipo que no está en la especificación, e.g. `feet` instead of `feat`
|
||||||
|
|
||||||
In a worst case scenario, it's not the end of the world if a commit lands that does not meet the conventional commit specification. It simply means that commit will be missed by tools that are based on the spec.
|
En el peor de los escenarios, no es el fin del mundo si aparece un commit que no
|
||||||
|
cumple con las especificaciones de los commits convencionales. Simplemente, el
|
||||||
|
commit será ignorado por las herramientas que se basen en esta especificación.
|
||||||
|
|
||||||
### Do all my contributors need to use the conventional commit specification?
|
### ¿Deben todos los que contribuyen a mi proyecto usar esta especificación?
|
||||||
|
|
||||||
No! If you use a squash based workflow on Git lead maintainers can cleanup the commit messages as they're merged—adding no workload to casual committers. A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
|
¡No! Si usa un flujo de trabajo basado en `squash` los líderes del proyecto
|
||||||
|
pueden limpiar el mensaje en el momento en que se incorpora, sin agregar cargas
|
||||||
|
adicionales a quienes contribuyen casualmente. Un flujo de trabajo común para
|
||||||
|
esto es configurar su sistema de git para que haga el `squash` de manera
|
||||||
|
automática de un pull request y presente al líder del proyecto un formulario
|
||||||
|
para que ingrese el mensaje de commit correcto al momento de hacer el merge.
|
||||||
|
|
||||||
## About
|
## Acerca de
|
||||||
|
|
||||||
The Conventional Commit specification is inspired by, and based heavily on, the [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit).
|
La especificación de Commits Convencionales está inspirada, y fuertemente
|
||||||
|
basada, en [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit).
|
||||||
|
|
||||||
The first draft of this specification has been written in collaboration with some of the
|
El primer borrador de esta especificación ha sido escrito en colaboración con
|
||||||
folks contributing to:
|
algunos de los colaboradores de:
|
||||||
|
|
||||||
* [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog): a
|
* [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog):
|
||||||
set of tools for parsing conventional commit messages from git histories.
|
una serie de herramientas para analizar los mensajes de los commits de los
|
||||||
* [unleash](https://github.com/netflix/unleash): a tool for automating the
|
historiales de git.
|
||||||
software release and publishing lifecycle.
|
* [unleash](https://github.com/netflix/unleash): una herramienta para
|
||||||
* [lerna](https://github.com/lerna/lerna): a tool for managing monorepos, which grew out
|
automatizar la liberación de software y ciclo de vida de publicación.
|
||||||
of the Babel project.
|
* [lerna](https://github.com/lerna/lerna): una herramienta para manejar
|
||||||
|
mono-repositorios, que creció a partir del proyecto Babel.
|
||||||
|
|
||||||
## Projects Using Conventional Commits
|
## Proyectos usando Commits Convencionales
|
||||||
|
|
||||||
* [yargs](https://github.com/yargs/yargs): everyone's favorite pirate themed command line argument parser.
|
* [yargs](https://github.com/yargs/yargs): el analizador de argumentos de la línea de comandos preferido por todos.
|
||||||
* [istanbuljs](https://github.com/istanbuljs/istanbuljs): a collection of open-source tools
|
* [istanbuljs](https://github.com/istanbuljs/istanbuljs): una colección de herramientas y librerías de código abierto para agregar cobertura de código a sus tests.
|
||||||
and libraries for adding test coverage to your JavaScript tests.
|
* [standard-version](https://github.com/conventional-changelog/standard-version): versionado automático y manejos de CHANGELOG, usando el botón de squash de GitHub y siguiendo el flujo de trabajo de los Commits Convencionales.
|
||||||
* [standard-version](https://github.com/conventional-changelog/standard-version): Automatic versioning and CHANGELOG management, using GitHub's new squash button and the recommended Conventional Commits workflow.
|
* [uPortal-home](https://github.com/UW-Madison-DoIT/angularjs-portal) y [uPortal-application-framework](https://github.com/UW-Madison-DoIT/uw-frame): mejoramiento opcional para la interfaz de usuario [Apereo uPortal](https://www.apereo.org/projects/uportal).
|
||||||
|
|
||||||
[](https://conventionalcommits.org)
|
[](https://conventionalcommits.org)
|
||||||
|
|
||||||
_want your project on this list?_ [send a pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls).
|
_¿Quiere ver su proyecto en esta lista?_ [haga un pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls).
|
||||||
|
|
||||||
## License
|
## Licencia
|
||||||
|
|
||||||
[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
|
[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
|
||||||
|
|||||||
@ -1,166 +0,0 @@
|
|||||||
---
|
|
||||||
title: Conventional Commits 1.0.0-beta
|
|
||||||
language: es
|
|
||||||
---
|
|
||||||
|
|
||||||
# Conventional Commits 1.0.0-beta
|
|
||||||
|
|
||||||
## Summary
|
|
||||||
|
|
||||||
As an open-source maintainer, squash feature branches onto `master` and write
|
|
||||||
a standardized commit message while doing so.
|
|
||||||
|
|
||||||
The commit message should be structured as follows:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
```
|
|
||||||
<type>[optional scope]: <description>
|
|
||||||
|
|
||||||
[optional body]
|
|
||||||
|
|
||||||
[optional footer]
|
|
||||||
```
|
|
||||||
---
|
|
||||||
|
|
||||||
<br />
|
|
||||||
The commit contains the following structural elements, to communicate intent to the
|
|
||||||
consumers of your library:
|
|
||||||
|
|
||||||
1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with [`PATCH`](http://semver.org/#summary) in semantic versioning).
|
|
||||||
2. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates
|
|
||||||
with [`MINOR`](http://semver.org/#summary) in semantic versioning).
|
|
||||||
3. **BREAKING CHANGE:** a commit that has the text `BREAKING CHANGE:` at the beginning of its optional body or footer section introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). A breaking change can be
|
|
||||||
part of commits of any _type_. E.g., a `fix:`, `feat:` & `chore:` types would all be valid, in addition to any other _type_.
|
|
||||||
|
|
||||||
<br />
|
|
||||||
A scope may be provided to a commit's type, to provide additional contextual information and
|
|
||||||
is contained within parenthesis, e.g., `feat(parser): adds ability to parse arrays`.
|
|
||||||
|
|
||||||
Commit _types_ other than `fix:` and `feat:` are allowed, for example [the Angular convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) recommends `docs:`, `style:`, `refactor:`, `perf:`, `test:`, `chore:`, but these tags are
|
|
||||||
not mandated by the conventional commits specification.
|
|
||||||
|
|
||||||
## Introduction
|
|
||||||
|
|
||||||
In software development, it's been my experience that bugs are most often introduced
|
|
||||||
at the boundaries between applications. Unit testing works great for testing the interactions
|
|
||||||
that an open-source maintainer knows about, but do a poor job of capturing all the
|
|
||||||
interesting, often unexpected, ways that a community puts a library to use.
|
|
||||||
|
|
||||||
Anyone who has upgraded to a new patch version of a dependency, only to watch their
|
|
||||||
application start throwing a steady stream of 500 errors, knows how important
|
|
||||||
a readable commit history (and [ideally a well maintained CHANGELOG](http://keepachangelog.com/en/0.3.0/)) is to the ensuing
|
|
||||||
forensic process.
|
|
||||||
|
|
||||||
The Conventional Commits specification proposes introducing a standardized lightweight
|
|
||||||
convention on top of commit messages. This convention dovetails with [SemVer](http://semver.org),
|
|
||||||
asking software developers to describe in commit messages, features, fixes, and breaking
|
|
||||||
changes that they make.
|
|
||||||
|
|
||||||
By introducing this convention, we create a common language that makes it easier to
|
|
||||||
debug issues across project boundaries.
|
|
||||||
|
|
||||||
## Conventional Commits Specification
|
|
||||||
|
|
||||||
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
|
|
||||||
|
|
||||||
1. commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc.,
|
|
||||||
followed by a colon and a space.
|
|
||||||
2. the type `feat` MUST be used when a commit adds a new feature to your application
|
|
||||||
or library.
|
|
||||||
3. the type `fix` MUST be used when a commit represents a bug fix for your application.
|
|
||||||
4. an optional scope MAY be provided after a type. A scope is a phrase describing
|
|
||||||
a section of the codebase enclosed in parenthesis, e.g., `fix(parser):`
|
|
||||||
5. A description MUST immediately follow the type/scope prefix.
|
|
||||||
The description is a short description of the pull request, e.g.,
|
|
||||||
_fix: array parsing issue when multiple spaces were contained in string._
|
|
||||||
6. A longer commit body MAY be provided after the short description. The body MUST
|
|
||||||
begin one blank line after the description.
|
|
||||||
7. A footer MAY be provided one blank line after the body. The footer SHOULD contain
|
|
||||||
additional meta-information about the pull-request (such as the issues it fixes, e.g., `fixes #13, #5`).
|
|
||||||
8. Breaking changes MUST be indicated at the very beginning of the footer or body section of a commit. A breaking change MUST consist of the uppercase text `BREAKING CHANGE`, followed by a colon and a space.
|
|
||||||
9. A description MUST be provided after the `BREAKING CHANGE: `, describing what
|
|
||||||
has changed about the API, e.g., _BREAKING CHANGE: environment variables now take precedence over config files._
|
|
||||||
10. types other than `feat` and `fix` MAY be used in your commit messages.
|
|
||||||
|
|
||||||
## Why Use Conventional Commits
|
|
||||||
|
|
||||||
* Automatically generating CHANGELOGs.
|
|
||||||
* Automatically determining a semantic version bump (based on the types of commits landed).
|
|
||||||
* Communicating the nature of changes to teammates, the public, and other stakeholders.
|
|
||||||
* Triggering build and publish processes.
|
|
||||||
* Making it easier for people to contribute to your projects, by allowing them to explore
|
|
||||||
a more structured commit history.
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
|
|
||||||
### How should I deal with commit messages in the initial development phase?
|
|
||||||
|
|
||||||
We recommend that you proceed as if you've an already released product. Typically *somebody*, even if its your fellow software developers, is using your software. They'll want to know what's fixed, what breaks etc.
|
|
||||||
|
|
||||||
### What do I do if the commit conforms to more than one of the commit types?
|
|
||||||
|
|
||||||
Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.
|
|
||||||
|
|
||||||
### Doesn’t this discourage rapid development and fast iteration?
|
|
||||||
|
|
||||||
It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors.
|
|
||||||
|
|
||||||
### Might Conventional Commits lead developers to limit the type of commits they make because they'll be thinking in the types provided?
|
|
||||||
|
|
||||||
Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time.
|
|
||||||
|
|
||||||
### How does this relate to SemVer?
|
|
||||||
|
|
||||||
`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases.
|
|
||||||
|
|
||||||
### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`?
|
|
||||||
|
|
||||||
We recommend using SemVer to release your own extensions to this specification (and
|
|
||||||
encourage you to make these extensions!)
|
|
||||||
|
|
||||||
### What do I do if I accidentally use the wrong commit type?
|
|
||||||
|
|
||||||
#### When you used a type that's of the spec but not the correct type, e.g. `fix` instead of `feat`
|
|
||||||
|
|
||||||
Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use.
|
|
||||||
|
|
||||||
#### When you used a type *not* of the spec, e.g. `feet` instead of `feat`
|
|
||||||
|
|
||||||
In a worst case scenario, it's not the end of the world if a commit lands that does not meet the conventional commit specification. It simply means that commit will be missed by tools that are based on the spec.
|
|
||||||
|
|
||||||
### Do all my contributors need to use the conventional commit specification?
|
|
||||||
|
|
||||||
No! If you use a squash based workflow on Git lead maintainers can cleanup the commit messages as they're merged—adding no workload to casual committers. A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
The Conventional Commit specification is inspired by, and based heavily on, the [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit).
|
|
||||||
|
|
||||||
The first draft of this specification has been written in collaboration with some of the
|
|
||||||
folks contributing to:
|
|
||||||
|
|
||||||
* [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog): a
|
|
||||||
set of tools for parsing conventional commit messages from git histories.
|
|
||||||
* [unleash](https://github.com/netflix/unleash): a tool for automating the
|
|
||||||
software release and publishing lifecycle.
|
|
||||||
* [lerna](https://github.com/lerna/lerna): a tool for managing monorepos, which grew out
|
|
||||||
of the Babel project.
|
|
||||||
|
|
||||||
## Projects Using Conventional Commits
|
|
||||||
|
|
||||||
* [yargs](https://github.com/yargs/yargs): Everyone's favorite pirate themed command line argument parser.
|
|
||||||
* [istanbuljs](https://github.com/istanbuljs/istanbuljs): A collection of open-source tools and libraries for adding test coverage to your JavaScript tests.
|
|
||||||
* [standard-version](https://github.com/conventional-changelog/standard-version): Automatic versioning and CHANGELOG management, using GitHub's new squash button and the recommended Conventional Commits workflow.
|
|
||||||
* [angular](https://github.com/angular/angular): Angular is a development platform for building mobile and desktop web applications using Typescript/JavaScript (JS) and other languages.
|
|
||||||
* [karma](https://github.com/karma-runner/karma): Spectacular Test Runner for JavaScript.
|
|
||||||
* [RxJS](https://github.com/ReactiveX/rxjs): A reactive programming library for JavaScript.
|
|
||||||
* [Cycle.js](https://github.com/cyclejs/cyclejs): A functional and reactive JavaScript framework for predictable code.
|
|
||||||
|
|
||||||
[](https://conventionalcommits.org)
|
|
||||||
|
|
||||||
_want your project on this list?_ [send a pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls).
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
|
|
||||||
249
lang/es/spec/v1.0.0-beta.2.md
Normal file
249
lang/es/spec/v1.0.0-beta.2.md
Normal file
@ -0,0 +1,249 @@
|
|||||||
|
---
|
||||||
|
title: Commits Convencionales 1.0.0-beta.2
|
||||||
|
language: es
|
||||||
|
---
|
||||||
|
|
||||||
|
# Commits Convencionales 1.0.0-beta.2
|
||||||
|
|
||||||
|
## Resumen
|
||||||
|
|
||||||
|
Al mantener proyectos de código abierto, cuando se incorporan ramas con nuevas
|
||||||
|
características en `master` al escribir un mensaje de commit estandarizado, el
|
||||||
|
mensaje del commit debe estar estructurado de la siguiente forma:
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
```
|
||||||
|
<tipo>[ámbito opcional]: <descripción>
|
||||||
|
|
||||||
|
[cuerpo opcional]
|
||||||
|
|
||||||
|
[nota de pie opcional]
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<br />
|
||||||
|
El commit contiene los siguientes elementos estructurales para comunicar la
|
||||||
|
intención al consumidor de la librería:
|
||||||
|
|
||||||
|
1. **fix:** un commit de _tipo_ `fix` corrige un error en la base del código
|
||||||
|
(se correlaciona con [`PATCH`](http://semver.org/#summary) en el versionado
|
||||||
|
semántico).
|
||||||
|
2. **feat:** un commit de _tipo_ `feat` introduce nuevas características en la
|
||||||
|
base del código (se correlaciona con [`MINOR`](http://semver.org/#summary)
|
||||||
|
en el versionado semántico).
|
||||||
|
3. **BREAKING CHANGE:** un commit que contiene el texto `BREAKING CHANGE:` al
|
||||||
|
inicio de su cuerpo opcional o la sección de nota de pie introduce un cambio
|
||||||
|
en el uso de la API (se correlaciona con [`MAJOR`](http://semver.org/#summary)
|
||||||
|
en el versionado semántico). Un cambio en el uso de la API puede ser parte
|
||||||
|
de commits de _tipo_. e.g., a `fix:`, `feat:` & `chore:` todos tipos
|
||||||
|
válidos, adicional a cualquier otro _tipo_.
|
||||||
|
4. Otros: _tipos_ de commits distintos a `fix:` y `feat:` están permitidos, por
|
||||||
|
ejemplo [commitlint-config-conventional](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional)
|
||||||
|
(basado en [the Angular convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit))
|
||||||
|
recomienda `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:` y
|
||||||
|
otros. También recomendamos `improvement` para commits que mejorar una
|
||||||
|
implementación actual sin añadir nuevas características ni corregir errores.
|
||||||
|
Tenga presente que estos tipos no son impuestos por la especificación de
|
||||||
|
commits convencionales y no tienen efecto implícito en el versionado
|
||||||
|
semántico (a menos que incluyan el texto BREAKING CHANGE, lo cual NO es
|
||||||
|
recomendado).
|
||||||
|
<br />
|
||||||
|
Se puede agregar un ámbito al _tipo_ de commit para proveer información
|
||||||
|
contextual adicional y se escribe entre paréntesis, e.g., `feat(parser): add ability to parse arrays`.
|
||||||
|
|
||||||
|
## Ejemplos
|
||||||
|
|
||||||
|
### Mensaje de commit con descripción y cambio en el uso de la API en el cuerpo
|
||||||
|
|
||||||
|
```
|
||||||
|
feat: allow provided config object to extend other configs
|
||||||
|
|
||||||
|
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mensaje de commit sin cuerpo
|
||||||
|
|
||||||
|
```
|
||||||
|
docs: correct spelling of CHANGELOG
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mensaje de commit con ámbito
|
||||||
|
|
||||||
|
```
|
||||||
|
feat(lang): added polish language
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mensaje de commit para una corrección usando un número de problema (opcional)
|
||||||
|
|
||||||
|
```
|
||||||
|
fix: minor typos in code
|
||||||
|
|
||||||
|
see the issue for details on the typos fixed
|
||||||
|
|
||||||
|
fixes issue #12
|
||||||
|
```
|
||||||
|
|
||||||
|
## Introducción
|
||||||
|
|
||||||
|
En el desarrollo de software, ha sido mi experiencia que los errores en el
|
||||||
|
código son introducidos con más frecuencia en las fronteras de la aplicación.
|
||||||
|
Los tests unitarios funcionan muy bien para probar las interacciones que el
|
||||||
|
mantenedor conoce, pero hacen un mal trabajo capturando la manera interesante,
|
||||||
|
a veces inesperada, en que una comunidad usa una librería.
|
||||||
|
|
||||||
|
Cualquiera que haya actualizado una versión corregida de una dependencia para
|
||||||
|
luego darse cuenta de que la aplicación empieza a arrojar un flujo de 500
|
||||||
|
errores, sabe lo importante que es un historial de commits legible (e
|
||||||
|
[idealmente un bien mantenido CHANGELOG](http://keepachangelog.com/en/0.3.0/))
|
||||||
|
para el consiguiente proceso forense.
|
||||||
|
|
||||||
|
La especificación de Commits Convencionales propone introducir una convención
|
||||||
|
estandarizada y ligera sobre los mensajes de los commits. Esta convención encaja
|
||||||
|
con [SemVer](http://semver.org), pidiéndole a los desarrolladores de software
|
||||||
|
describir en los mensajes de los commits, las características, correcciones y
|
||||||
|
cambios que rompen el uso de la API que hagan.
|
||||||
|
|
||||||
|
Al introducir esta convención, creamos un lenguaje común que permite depurar más
|
||||||
|
fácilmente los problemas a través de las fronteras de un proyecto.
|
||||||
|
|
||||||
|
## Especificación de Commits Convencionales
|
||||||
|
|
||||||
|
Las palabras “DEBE” (“MUST”), “NO DEBE” (“MUST NOT”), “REQUIERE” (“REQUIRED”),
|
||||||
|
“DEBERÁ” (“SHALL”), “NO DEBERÁ” (“SHALL NOT”), “DEBERÍA” (“SHOULD”),
|
||||||
|
“NO DEBERÍA” (“SHOULD NOT”), “RECOMIENDA” (“RECOMMENDED”), “PUEDE” (“MAY”) Y
|
||||||
|
“OPCIONAL” (“OPTIONAL”) en este documento se deben interpretar como se describe
|
||||||
|
en [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
|
||||||
|
|
||||||
|
1. Los commits DEBEN iniciar con un tipo que consiste en un sustantivo `feat`, `fix`, etc.,
|
||||||
|
seguido de dos puntos y un espacio.
|
||||||
|
2. El tipo `feat` DEBE ser usado cuando un commit agrega una nueva
|
||||||
|
característica a la aplicación o librería.
|
||||||
|
3. El tipo `fix` DEBE ser usado cuando el commit representa una corrección a un
|
||||||
|
error en el código de la aplicación.
|
||||||
|
4. Se PUEDE añadir un ámbito opcional después del tipo. El ámbito es una frase
|
||||||
|
que describe una sección de la base del código encerrada en paréntesis,
|
||||||
|
e.g., `fix(parser):`
|
||||||
|
5. Una descripción DEBE ir inmediatamente después del tipo/ámbito inicial y es
|
||||||
|
una descripción corta de los cambios realizados en el código, e.g.,
|
||||||
|
_fix: array parsing issue when multiple spaces were contained in string._
|
||||||
|
6. Un cuerpo del commit más extenso PUEDE agregarse después de la descripción,
|
||||||
|
dando información contextual adicional acerca de los cambios en el código.
|
||||||
|
El cuerpo DEBE iniciar con una línea en blanco después de la descripción.
|
||||||
|
7. Una nota de pie PUEDE agregarse tras una línea en blanco después del
|
||||||
|
cuerpo o después de la descripción en caso de que no se haya dado un cuerpo.
|
||||||
|
La nota de pie DEBE contener referencias adicionales a los números de
|
||||||
|
problemas registrados sobre el cambio del código (como el número de problema
|
||||||
|
que corrige, e.g.,`Fixes #13`).
|
||||||
|
8. Los cambios que rompen la API DEBEN ser indicados al inicio de la nota de
|
||||||
|
pie o el cuerpo del commit. Un cambio que rompe la API DEBE contener el
|
||||||
|
texto en mayúsculas `BREAKING CHANGE`, seguido de dos puntos y espacio.
|
||||||
|
9. Una descripción se DEBE proveer después de `BREAKING CHANGE:`, describiendo
|
||||||
|
qué ha cambiado en la API, e.g., _BREAKING CHANGE: environment variables now take precedence over config files._
|
||||||
|
10. La nota de pie DEBE contener solamente el texto `BREAKING CHANGE`, vínculos
|
||||||
|
externos, referencias a problemas u otra metainformación.
|
||||||
|
11. Otros tipos distintos a `feat` y `fix` PUEDEN ser usados en los mensajes de
|
||||||
|
los commits.
|
||||||
|
|
||||||
|
## ¿Por qué usar Commits Convencionales?
|
||||||
|
|
||||||
|
* Generación automática de CHANGELOGs.
|
||||||
|
* Determinación automática de los cambios de versión (basado en los tipos de
|
||||||
|
commits).
|
||||||
|
* Comunicar la naturaleza de los cambios a los demás integrantes del equipo, el
|
||||||
|
público o cualquier otro interesado.
|
||||||
|
* Ejecutar procesos de ejecución y publicación.
|
||||||
|
* Hacer más fácil a otras personas contribuir al proyecto, permitiendo explorar
|
||||||
|
una historia de los commits más estructurada.
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
### ¿Cómo puedo trabajar con los mensajes de los commits en la etapa inicial de desarrollo?
|
||||||
|
|
||||||
|
Recomendamos trabajar como si ya hubiera lanzado su producto. Típicamente
|
||||||
|
_alguien_, incluso si son sus compañeros desarrolladores, están usando su
|
||||||
|
producto. Ellos querrán saber que se ha arreglado, que se ha dañado, etc.
|
||||||
|
|
||||||
|
### ¿Qué debo hacer si un commit encaja en más de un tipo de commit?
|
||||||
|
|
||||||
|
Regrese y haga múltiples commits de ser posible. Parte de los beneficios de los
|
||||||
|
Commits Convencionales es la habilidad para hacer commits más organizados y así
|
||||||
|
mismo PRs.
|
||||||
|
|
||||||
|
### ¿No desalienta esto el desarrollo y la iteración rápida?
|
||||||
|
|
||||||
|
Desalienta moverse rápido de una forma desorganizada. Ayuda a moverse rápido a
|
||||||
|
largo plazo a través de proyectos con una gran variedad de contribuidores.
|
||||||
|
|
||||||
|
### ¿Pueden los Commits Convencionales llevar a los desarrolladores a limitar el tipo de commits que hacen ya que estarán pensando en los tipos previstos?
|
||||||
|
|
||||||
|
Los Commits Convencionales nos animan a hacer más de cierto tipo de commits como
|
||||||
|
_fixes_. Adicionalmente, la flexibilidad de los Commits Convencionales permite
|
||||||
|
a su equipo generar sus propios tipos y cambiarlos a lo largo del tiempo.
|
||||||
|
|
||||||
|
### ¿Cómo se relaciona esto con SemVer?
|
||||||
|
|
||||||
|
El tipo de commit `fix` se traduce a un cambio de versión `PATCH`. El tipo de
|
||||||
|
commit `feat` se traduce a un cambio de versión `MINOR`. Commits con el texto
|
||||||
|
`BREAKING CHANGE`, sin importar su tipo, se traducen a un cambio de versión
|
||||||
|
`MAJOR`.
|
||||||
|
|
||||||
|
### ¿Cómo puedo versionar mis extensiones a la especificación de Commits Convencionales, e.g. `@jameswomack/conventional-commit-spec`?
|
||||||
|
|
||||||
|
Recomendamos usar SemVer para liberar su propia extensión a esta especificación
|
||||||
|
(¡y lo animamos a hacer esta extensión!)
|
||||||
|
|
||||||
|
### ¿Qué debo hacer si por accidente uso un tipo de commit equivocado?
|
||||||
|
|
||||||
|
#### Cuando utiliza un tipo que es de la especificación pero no es el correcto, e.g. `fix` en lugar de `feat`
|
||||||
|
|
||||||
|
Antes de combinar o liberar el error, recomendamos usar `git rebase -i` para
|
||||||
|
editar la historia de los commits. Después de que se ha liberado, la limpieza
|
||||||
|
será distinta de acuerdo con las herramientas y procesos que usted use.
|
||||||
|
|
||||||
|
#### Cuanto se usa un tipo que no está en la especificación, e.g. `feet` instead of `feat`
|
||||||
|
|
||||||
|
En el peor de los escenarios, no es el fin del mundo si aparece un commit que no
|
||||||
|
cumple con las especificaciones de los commits convencionales. Simplemente, el
|
||||||
|
commit será ignorado por las herramientas que se basen en esta especificación.
|
||||||
|
|
||||||
|
### ¿Deben todos los que contribuyen a mi proyecto usar esta especificación?
|
||||||
|
|
||||||
|
¡No! Si usa un flujo de trabajo basado en `squash` los líderes del proyecto
|
||||||
|
pueden limpiar el mensaje en el momento en que se incorpora, sin agregar cargas
|
||||||
|
adicionales a quienes contribuyen casualmente. Un flujo de trabajo común para
|
||||||
|
esto es configurar su sistema de git para que haga el `squash` de manera
|
||||||
|
automática de un pull request y presente al líder del proyecto un formulario
|
||||||
|
para que ingrese el mensaje de commit correcto al momento de hacer el merge.
|
||||||
|
|
||||||
|
## Acerca de
|
||||||
|
|
||||||
|
La especificación de Commits Convencionales está inspirada, y fuertemente
|
||||||
|
basada, en [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit).
|
||||||
|
|
||||||
|
El primer borrador de esta especificación ha sido escrito en colaboración con
|
||||||
|
algunos de los colaboradores de:
|
||||||
|
|
||||||
|
* [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog):
|
||||||
|
una serie de herramientas para analizar los mensajes de los commits de los
|
||||||
|
historiales de git.
|
||||||
|
* [unleash](https://github.com/netflix/unleash): una herramienta para
|
||||||
|
automatizar la liberación de software y ciclo de vida de publicación.
|
||||||
|
* [lerna](https://github.com/lerna/lerna): una herramienta para manejar
|
||||||
|
mono-repositorios, que creció a partir del proyecto Babel.
|
||||||
|
|
||||||
|
## Proyectos usando Commits Convencionales
|
||||||
|
|
||||||
|
* [yargs](https://github.com/yargs/yargs): el analizador de argumentos de la línea de comandos preferido por todos.
|
||||||
|
* [istanbuljs](https://github.com/istanbuljs/istanbuljs): una colección de herramientas y librerías de código abierto para agregar cobertura de código a sus tests.
|
||||||
|
* [standard-version](https://github.com/conventional-changelog/standard-version): versionado automático y manejos de CHANGELOG, usando el botón de squash de GitHub y siguiendo el flujo de trabajo de los Commits Convencionales.
|
||||||
|
* [uPortal-home](https://github.com/UW-Madison-DoIT/angularjs-portal) y [uPortal-application-framework](https://github.com/UW-Madison-DoIT/uw-frame): mejoramiento opcional para la interfaz de usuario [Apereo uPortal](https://www.apereo.org/projects/uportal).
|
||||||
|
|
||||||
|
[](https://conventionalcommits.org)
|
||||||
|
|
||||||
|
_¿Quiere ver su proyecto en esta lista?_ [haga un pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls).
|
||||||
|
|
||||||
|
## Licencia
|
||||||
|
|
||||||
|
[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
|
||||||
@ -1,163 +0,0 @@
|
|||||||
---
|
|
||||||
title: Conventional Commits 1.0.0-beta
|
|
||||||
language: es
|
|
||||||
---
|
|
||||||
|
|
||||||
# Conventional Commits 1.0.0-beta
|
|
||||||
|
|
||||||
## Summary
|
|
||||||
|
|
||||||
As an open-source maintainer, squash feature branches onto `master` and write
|
|
||||||
a standardized commit message while doing so.
|
|
||||||
|
|
||||||
The commit message should be structured as follows:
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
```
|
|
||||||
<type>[optional scope]: <description>
|
|
||||||
|
|
||||||
[optional body]
|
|
||||||
|
|
||||||
[optional footer]
|
|
||||||
```
|
|
||||||
---
|
|
||||||
|
|
||||||
<br />
|
|
||||||
The commit contains the following structural elements, to communicate intent to the
|
|
||||||
consumers of your library:
|
|
||||||
|
|
||||||
1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with [`PATCH`](http://semver.org/#summary) in semantic versioning).
|
|
||||||
2. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates
|
|
||||||
with [`MINOR`](http://semver.org/#summary) in semantic versioning).
|
|
||||||
3. **BREAKING CHANGE:** a commit that has the text `BREAKING CHANGE:` at the beginning of its optional body or footer section introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). A breaking change can be
|
|
||||||
part of either a `fix:` or `feat:` _type_ commit.
|
|
||||||
|
|
||||||
<br />
|
|
||||||
A scope may be provided to a commit's type, to provide additional contextual information and
|
|
||||||
is contained within parenthesis, e.g., `feat(parser): adds ability to parse arrays`.
|
|
||||||
|
|
||||||
Commit _types_ other than `fix:` and `feat:` are allowed, for example [the Angular convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) recommends `docs:`, `style:`, `refactor:`, `perf:`, `test:`, `chore:`, but these tags are
|
|
||||||
not mandated by the conventional commits specification.
|
|
||||||
|
|
||||||
## Introduction
|
|
||||||
|
|
||||||
In software development, it's been my experience that bugs are most often introduced
|
|
||||||
at the boundaries between applications. Unit testing works great for testing the interactions
|
|
||||||
that an open-source maintainer knows about, but do a poor job of capturing all the
|
|
||||||
interesting, often unexpected, ways that a community puts a library to use.
|
|
||||||
|
|
||||||
Anyone who has upgraded to a new patch version of a dependency, only to watch their
|
|
||||||
application start throwing a steady stream of 500 errors, knows how important
|
|
||||||
a readable commit history (and [ideally a well maintained CHANGELOG](http://keepachangelog.com/en/0.3.0/)) is to the ensuing
|
|
||||||
forensic process.
|
|
||||||
|
|
||||||
The Conventional Commits specification proposes introducing a standardized lightweight
|
|
||||||
convention on top of commit messages. This convention dovetails with [SemVer](http://semver.org),
|
|
||||||
asking software developers to describe in commit messages, features, fixes, and breaking
|
|
||||||
changes that they make.
|
|
||||||
|
|
||||||
By introducing this convention, we create a common language that makes it easier to
|
|
||||||
debug issues across project boundaries.
|
|
||||||
|
|
||||||
## Conventional Commits Specification
|
|
||||||
|
|
||||||
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
|
|
||||||
|
|
||||||
1. commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc.,
|
|
||||||
followed by a colon and a space.
|
|
||||||
2. the type `feat` MUST be used when a commit adds a new feature to your application
|
|
||||||
or library.
|
|
||||||
3. the type `fix` MUST be used when a commit represents a bug fix for your application.
|
|
||||||
4. an optional scope MAY be provided after a type. A scope is a phrase describing
|
|
||||||
a section of the codebase enclosed in parenthesis, e.g., `fix(parser):`
|
|
||||||
5. A description MUST immediately follow the type/scope prefix.
|
|
||||||
The description is a short description of the pull request, e.g.,
|
|
||||||
_fix: array parsing issue when multiple spaces were contained in string._
|
|
||||||
6. A longer commit body MAY be provided after the short description. The body MUST
|
|
||||||
begin one blank line after the description.
|
|
||||||
7. A footer MAY be provided one blank line after the body. The footer SHOULD contain
|
|
||||||
additional meta-information about the pull-request (such as the issues it fixes, e.g., `fixes #13, #5`).
|
|
||||||
8. Breaking changes MUST be indicated at the very beginning of the footer or body section of a commit. A breaking change MUST consist of the uppercase text `BREAKING CHANGE`, followed by a colon and a space.
|
|
||||||
9. A description MUST be provided after the `BREAKING CHANGE: `, describing what
|
|
||||||
has changed about the API, e.g., _BREAKING CHANGE: environment variables now take precedence over config files._
|
|
||||||
10. types other than `feat` and `fix` MAY be used in your commit messages.
|
|
||||||
|
|
||||||
## Why Use Conventional Commits
|
|
||||||
|
|
||||||
* Automatically generating CHANGELOGs.
|
|
||||||
* Automatically determining a semantic version bump (based on the types of commits landed).
|
|
||||||
* Communicating the nature of changes to teammates, the public, and other stakeholders.
|
|
||||||
* Triggering build and publish processes.
|
|
||||||
* Making it easier for people to contribute to your projects, by allowing them to explore
|
|
||||||
a more structured commit history.
|
|
||||||
|
|
||||||
## FAQ
|
|
||||||
|
|
||||||
### How should I deal with commit messages in the initial development phase?
|
|
||||||
|
|
||||||
We recommend that you proceed as if you've an already released product. Typically *somebody*, even if its your fellow software developers, is using your software. They'll want to know what's fixed, what breaks etc.
|
|
||||||
|
|
||||||
### What do I do if the commit conforms to more than one of the commit types?
|
|
||||||
|
|
||||||
Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.
|
|
||||||
|
|
||||||
### Doesn’t this discourage rapid development and fast iteration?
|
|
||||||
|
|
||||||
It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors.
|
|
||||||
|
|
||||||
### Might Conventional Commits lead developers to limit the type of commits they make because they'll be thinking in the types provided?
|
|
||||||
|
|
||||||
Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time.
|
|
||||||
|
|
||||||
### How does this relate to SemVer?
|
|
||||||
|
|
||||||
`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases.
|
|
||||||
|
|
||||||
### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`?
|
|
||||||
|
|
||||||
We recommend using SemVer to release your own extensions to this specification (and
|
|
||||||
encourage you to make these extensions!)
|
|
||||||
|
|
||||||
### What do I do if I accidentally use the wrong commit type?
|
|
||||||
|
|
||||||
#### When you used a type that's of the spec but not the correct type, e.g. `fix` instead of `feat`
|
|
||||||
|
|
||||||
Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use.
|
|
||||||
|
|
||||||
#### When you used a type *not* of the spec, e.g. `feet` instead of `feat`
|
|
||||||
|
|
||||||
In a worst case scenario, it's not the end of the world if a commit lands that does not meet the conventional commit specification. It simply means that commit will be missed by tools that are based on the spec.
|
|
||||||
|
|
||||||
### Do all my contributors need to use the conventional commit specification?
|
|
||||||
|
|
||||||
No! If you use a squash based workflow on Git lead maintainers can cleanup the commit messages as they're merged—adding no workload to casual committers. A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
|
|
||||||
|
|
||||||
## About
|
|
||||||
|
|
||||||
The Conventional Commit specification is inspired by, and based heavily on, the [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit).
|
|
||||||
|
|
||||||
The first draft of this specification has been written in collaboration with some of the
|
|
||||||
folks contributing to:
|
|
||||||
|
|
||||||
* [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog): a
|
|
||||||
set of tools for parsing conventional commit messages from git histories.
|
|
||||||
* [unleash](https://github.com/netflix/unleash): a tool for automating the
|
|
||||||
software release and publishing lifecycle.
|
|
||||||
* [lerna](https://github.com/lerna/lerna): a tool for managing monorepos, which grew out
|
|
||||||
of the Babel project.
|
|
||||||
|
|
||||||
## Projects Using Conventional Commits
|
|
||||||
|
|
||||||
* [yargs](https://github.com/yargs/yargs): everyone's favorite pirate themed command line argument parser.
|
|
||||||
* [istanbuljs](https://github.com/istanbuljs/istanbuljs): a collection of open-source tools
|
|
||||||
and libraries for adding test coverage to your JavaScript tests.
|
|
||||||
* [standard-version](https://github.com/conventional-changelog/standard-version): Automatic versioning and CHANGELOG management, using GitHub's new squash button and the recommended Conventional Commits workflow.
|
|
||||||
|
|
||||||
[](https://conventionalcommits.org)
|
|
||||||
|
|
||||||
_want your project on this list?_ [send a pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls).
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/)
|
|
||||||
Loading…
Reference in New Issue
Block a user