Skip to content

docs(readme): add the optional status of body and footer #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2020
Merged
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ The header has a special format that includes a **type**, a **scope** and a **su

- The first line of the commit message (the "Subject") cannot be longer than 70 characters.
- Any other line of the commit message cannot be longer 100 characters!
- The body and footer are optional, but depends on the type some information can be mandatory.

This allows the message to be easier to read on github as well as in various git tools.

Expand Down Expand Up @@ -97,11 +98,15 @@ Here are some recommandation for writing your subject:
### Body

The body should include the motivation for the change and contrast this with previous behavior.
It is optional but highly recommended for any impacting changes.

### Footer

The footer should contain any information about **Breaking Changes** and is also the place to
reference JIRA ticket related to this commit.

The footer is optional but for **feat** and **fix** type the JIRA reference is mandatory.

The breaking changes must be at the end of the commit with only "BROKEN:" before the list of breaking changes.
They must be each on a new line.

Expand Down