Skip to content

Commit a1d5597

Browse files
author
Matthew Fisher
committed
style(contributing.md): remove backtick syntax
This works only with github-flavored markdown.
1 parent 821efa7 commit a1d5597

1 file changed

Lines changed: 14 additions & 18 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,38 +38,34 @@ Thanks for your contributions!
3838
We follow a rough convention for commit messages borrowed from CoreOS, who borrowed theirs
3939
from AngularJS. This is an example of a commit:
4040

41-
```
4241
feat(scripts/test-cluster): add a cluster test command
4342

4443
this uses tmux to setup a test cluster that you can easily kill and
4544
start for debugging.
46-
```
4745

4846
To make it more formal it looks something like this:
4947

50-
```
51-
{type}({scope}): {subject}
52-
<BLANK LINE>
53-
{body}
54-
<BLANK LINE>
55-
{footer}
56-
```
48+
49+
{type}({scope}): {subject}
50+
<BLANK LINE>
51+
{body}
52+
<BLANK LINE>
53+
{footer}
54+
5755

5856
Any line of the commit message cannot be longer than 90 characters, with the subject line
5957
limited to 70 characters. This allows the message to be easier to read on github as well
6058
as in various git tools.
6159

6260
The allowed {types} are as follows:
6361

64-
```
65-
feat -> feature
66-
fix -> bug fix
67-
docs -> documentation
68-
style -> formatting
69-
refactor
70-
test -> adding missing tests
71-
chore -> maintenance
72-
```
62+
feat -> feature
63+
fix -> bug fix
64+
docs -> documentation
65+
style -> formatting
66+
refactor
67+
test -> adding missing tests
68+
chore -> maintenance
7369

7470
### More Details on Commits
7571

0 commit comments

Comments
 (0)