Skip to content
This repository has been archived by the owner on Feb 5, 2018. It is now read-only.

Commit

Permalink
docs(format): tweak
Browse files Browse the repository at this point in the history
**header** is mandatory.
other parts should be a title.
  • Loading branch information
stevemao committed Aug 18, 2015
1 parent 9db101d commit 0272461
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

A minimum input should contain a raw message.

Each commit message consists of a a **header**, a **body** (optional) and a **footer** (optional).
Each commit message consists of a a **header** (mandatory), a **body** and a **footer**.

```
<header>
Expand All @@ -32,6 +32,8 @@ The footer should contain any information about **Important Notes** (optional) a
<references>
```

### other parts

This module will only parse the message body. However, it is possible to include other fields such as hash, committer or date.

```
Expand Down

0 comments on commit 0272461

Please sign in to comment.