forked/hyper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(CONTRIBUTING): Fix markdown

Browse Source 
Fix markdown in contributing so it displays correctly on github, and
also because of the irony.
This commit is contained in:
Richard Dodd
2017-03-28 11:32:18 +01:00
parent 3da720a99f
commit 1ee26443f4
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -20,13 +20,13 @@ we use the git commit messages to **generate the change log**.
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special 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**: format that includes a **type**, a **scope** and a **subject**:
`` ```
<type>(<scope>): <subject> <type>(<scope>): <subject>
<BLANK LINE> <BLANK LINE>
<body> <body>
<BLANK LINE> <BLANK LINE>
<footer> <footer>
`` ```
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier 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. to read on github as well as in various git tools.
@@ -64,11 +64,13 @@ The subject contains succinct description of the change:
* don't capitalize first letter * don't capitalize first letter
* no dot (.) at the end * no dot (.) at the end
###Body ### Body
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes" Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes"
The body should include the motivation for the change and contrast this with previous behavior. The body should include the motivation for the change and contrast this with previous behavior.
###Footer ### Footer
The footer should contain any information about **Breaking Changes** and is also the place to The footer should contain any information about **Breaking Changes** and is also the place to
reference GitHub issues that this commit **Closes**. reference GitHub issues that this commit **Closes**.