Skip to content

Commit

Permalink
style(contributing.md): remove backtick syntax
Browse files Browse the repository at this point in the history
This works only with github-flavored markdown.
  • Loading branch information
Matthew Fisher committed Jul 25, 2014
1 parent 821efa7 commit a1d5597
Showing 1 changed file with 14 additions and 18 deletions.
32 changes: 14 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,38 +38,34 @@ Thanks for your contributions!
We follow a rough convention for commit messages borrowed from CoreOS, who borrowed theirs
from AngularJS. This is an example of a commit:

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

this uses tmux to setup a test cluster that you can easily kill and
start for debugging.
```

To make it more formal it looks something like this:

```
{type}({scope}): {subject}
<BLANK LINE>
{body}
<BLANK LINE>
{footer}
```

{type}({scope}): {subject}
<BLANK LINE>
{body}
<BLANK LINE>
{footer}


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

The allowed {types} are as follows:

```
feat -> feature
fix -> bug fix
docs -> documentation
style -> formatting
refactor
test -> adding missing tests
chore -> maintenance
```
feat -> feature
fix -> bug fix
docs -> documentation
style -> formatting
refactor
test -> adding missing tests
chore -> maintenance

### More Details on Commits

Expand Down

0 comments on commit a1d5597

Please sign in to comment.