Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

docs(CONTRIBUTING): revert should be a valid type #12032

Closed
wants to merge 3 commits into from
Closed

docs(CONTRIBUTING): revert should be a valid type #12032

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1509bc8
docs(CONTRIBUTING): revert is a modifier
stevemao Jul 1, 2015
5b49dbb
docs(CONTRIBUTING): how to write a breaking change
stevemao Jul 1, 2015
22ba886
docs(CONTRIBUTING): state what is mandatory or optional
stevemao Jul 1, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,9 +199,14 @@ format that includes a **type**, a **scope** and a **subject**:
<footer>
```

The **header** is mandatory and the **scope** of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
to read on github as well as in various git tools.

### Revert
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(where the hash is the SHA of the commit being reverted) :-)

### Type
Must be one of the following:

Expand Down Expand Up @@ -235,6 +240,7 @@ The body should include the motivation for the change and contrast this with pre
The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**.

**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

A detailed explanation can be found in this [document][commit-message-format].

Expand Down