kreyren/ OSHW-DEIMOS
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Commit msg now has bash formatting

This commit is contained in:
JC Staudt 2018-05-31 16:55:34 -07:00 committed by GitHub
parent ad5dc2b514
commit 2762088c64
Signed by: GitHub
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -43,10 +43,12 @@ Always write a clear log message for your commits.
Simply saying "Update" is not adequate to understand what change(s) you made. Simply saying "Update" is not adequate to understand what change(s) you made.
One-line messages are fine for small changes, but bigger changes should look like this: One-line messages are fine for small changes, but bigger changes should look like this:
```bash
$ git commit -m "A brief summary of the commit (max 50 chars) $ git commit -m "A brief summary of the commit (max 50 chars)
> >
> An optional paragraph describing what changed and its impact." > An optional paragraph describing what changed and its impact."
```
Please ensure that all of your commits are atomic (one feature per commit). Please ensure that all of your commits are atomic (one feature per commit).
This helps prevent tons of headaches digging through code in an attempt to reproduce your steps. This helps prevent tons of headaches digging through code in an attempt to reproduce your steps.