Skip to content

Commit 0d0fb09

Browse files
committed
Add initial contributing guidelines
1 parent 5125b58 commit 0d0fb09

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
Contribution Guidelines
2+
===
3+
> Project contribution guidelines.
4+
5+
When contributing to this project, please follow the provided guidelines.
6+
7+
===
8+
## Style Guides
9+
10+
#### JavaScript
11+
12+
(...coming soon...)
13+
14+
15+
#### R
16+
17+
(...coming soon...)
18+
19+
20+
#### Julia
21+
22+
(...coming soon...)
23+
24+
25+
#### Python
26+
27+
(...coming soon...)
28+
29+
30+
#### Go
31+
32+
(...coming soon...)
33+
34+
35+
#### C/C++
36+
37+
(...coming soon...)
38+
39+
40+
#### Make
41+
42+
(...coming soon...)
43+
44+
45+
#### Bash
46+
47+
(...coming soon...)
48+
49+
50+
===
51+
## Git
52+
53+
* All commits should follow the [seven rules][git-seven-rules] of a `git` commit message:
54+
1. Use the [imperative mood][imperative-mood] in the `git` commit subject line.
55+
1. Capitalize the first word of the subject line.
56+
1. Do __not__ end the subject line with a period.
57+
1. Separate the subject line from the body with a blank line.
58+
1. Try to limit the subject line to `50` characters.
59+
1. Use the body to explain the *what* and *why*, and not the *how*.
60+
1. Try to wrap the body at `72` characters.
61+
62+
63+
64+
65+
<!-- <links> -->
66+
[git-seven-rules]: http://chris.beams.io/posts/git-commit/
67+
[imperative-mood]: https://en.wikipedia.org/wiki/Imperative_mood
68+
<!-- </links> -->

0 commit comments

Comments
 (0)