mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2024-11-15 02:45:15 +01:00
144 lines
7.8 KiB
Markdown
144 lines
7.8 KiB
Markdown
---
|
||
draft: false
|
||
aliases: ["/en/"]
|
||
---
|
||
|
||
# Conventional Commits 1.0.0-beta.3
|
||
|
||
## Summary
|
||
|
||
The Conventional Commits specification is a lightweight convention on top of commit messages.
|
||
It provides an easy set of rules for creating an explicit commit history;
|
||
which makes it easier to write automated tools on top of.
|
||
This convention dovetails with [SemVer](http://semver.org),
|
||
by describing the features, fixes, and breaking changes made in commit messages.
|
||
|
||
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).
|
||
1. **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).
|
||
1. **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_.
|
||
1. Others: commit _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others.
|
||
|
||
We also recommend `improvement` for commits that improve a current implementation without adding a new feature or fixing a bug.
|
||
Notice these types are not mandated by the conventional commits specification, and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE).
|
||
<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): add ability to parse arrays`.
|
||
|
||
## Examples
|
||
|
||
### Commit message with description and breaking change in body
|
||
```
|
||
feat: allow provided config object to extend other configs
|
||
|
||
BREAKING CHANGE: `extends` key in config file is now used for extending other config files
|
||
```
|
||
|
||
### Commit message with no body
|
||
```
|
||
docs: correct spelling of CHANGELOG
|
||
```
|
||
|
||
### Commit message with scope
|
||
```
|
||
feat(lang): added polish language
|
||
```
|
||
|
||
### Commit message for a fix using an (optional) issue number.
|
||
```
|
||
fix: minor typos in code
|
||
|
||
see the issue for details on the typos fixed
|
||
|
||
fixes issue #12
|
||
```
|
||
|
||
## 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.
|
||
1. The type `feat` MUST be used when a commit adds a new feature to your application or library.
|
||
1. The type `fix` MUST be used when a commit represents a bug fix for your application.
|
||
1. 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):`
|
||
1. A description MUST immediately follow the type/scope prefix.
|
||
The description is a short description of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string._
|
||
1. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
|
||
1. A footer MAY be provided one blank line after the body.
|
||
The footer SHOULD contain additional issue references about the code changes (such as the issues it fixes, e.g.,`Fixes #13`).
|
||
1. 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.
|
||
1. 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._
|
||
1. The footer MUST only contain `BREAKING CHANGE`, external links, issue references, and other meta-information.
|
||
1. 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.
|
||
|
||
### Are the types in the commit title uppercase or lowercase?
|
||
|
||
Any casing may be used, but it's best to be consistent.
|
||
|
||
### 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 clean up 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.
|