From 0272461f100984f340d52674ea62d2f7d3f9ae9b Mon Sep 17 00:00:00 2001 From: Steve Mao Date: Tue, 18 Aug 2015 11:04:18 +1000 Subject: [PATCH] docs(format): tweak **header** is mandatory. other parts should be a title. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 21ac1fe..abac751 100644 --- a/README.md +++ b/README.md @@ -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**. ```
@@ -32,6 +32,8 @@ The footer should contain any information about **Important Notes** (optional) a ``` +### other parts + This module will only parse the message body. However, it is possible to include other fields such as hash, committer or date. ```