Skip to content

Commit

Permalink
docs(contrib): add atomic commits requirement
Browse files Browse the repository at this point in the history
  • Loading branch information
pvdlg committed Jan 8, 2018
1 parent adbcca6 commit 49ad198
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -3,7 +3,6 @@
✨ Thanks for contributing to **semantic-release**! ✨

As a contributor, here are the guidelines we would like you to follow:

- [Code of conduct](#code-of-conduct)
- [How can I contribute?](#how-can-i-contribute)
- [Using the issue tracker](#using-the-issue-tracker)
Expand Down Expand Up @@ -119,6 +118,15 @@ To ensure consistency and quality all documentation modification must:

### Commit message guidelines

#### Atomic commits

If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means:
- a commit should contain exactly one self-contained functional change
- a functional change should be contained in exactly one commit
- a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...)

A complex feature can be broken down into multiple commits as long as each one keep a consistent state and consist of a self-contained change.

#### Commit message format

Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
Expand Down

0 comments on commit 49ad198

Please sign in to comment.