-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3a4dff3
commit ae75eab
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# How to contribute | ||
|
||
## GIT | ||
|
||
### Message Format | ||
There are a few basic rules that makes Git commit messages more readable on the terminal and GitHub. The most important rule is use the first line as a summary and to keep it short. | ||
|
||
According to [Pro Git: Chapter 5.2](http://progit.org/book/ch5-2.html#Commit-Guidelines) we use this template: | ||
|
||
Short (50 chars or less) summary of changes | ||
|
||
More detailed explanatory text, if necessary. Wrap it to about 72 | ||
characters or so. In some contexts, the first line is treated as the | ||
subject of an email and the rest of the text as the body. The blank | ||
line separating the summary from the body is critical (unless you omit | ||
the body entirely); tools like rebase can get confused if you run the | ||
two together. | ||
|
||
Further paragraphs come after blank lines. | ||
|
||
- Bullet points are okay, too | ||
|
||
- Typically a hyphen or asterisk is used for the bullet, preceded by a | ||
single space, with blank lines in between, but conventions vary here | ||
|
||
### Branching | ||
We want to keep our commit histories clean where possible. | ||
- master / dev / feature-<name> / hotfixex / release-<version> for branches. | ||
- merging with `--no-ff` option; | ||
- remember about `git rebase`; |