11Contribution Guidelines
22===
3+
34> Project contribution guidelines.
45
56When contributing to this project, please follow the provided guidelines.
67
8+ * Read and understood the style guides.
9+ * Read and understand the [ Code of Conduct] [ code-of-conduct ] .
10+ * Read and understood the [ licensing terms] [ license ] .
11+
712===
13+
814## Style Guides
915
1016#### JavaScript
@@ -16,22 +22,22 @@ When contributing to this project, please follow the provided guidelines.
1622
1723(...coming soon...)
1824
19- * Google [ style guide] ( https://google.github.io/styleguide/Rguide.xml )
20- * Hadley's [ notes] ( http://adv-r.had.co.nz/OO-essentials.html ) , which include a comment on ` function ` name conventions
25+ * Google [ style guide] ( https://google.github.io/styleguide/Rguide.xml )
26+ * Hadley's [ notes] ( http://adv-r.had.co.nz/OO-essentials.html ) , which include a comment on ` function ` name conventions
2127
2228
2329#### Julia
2430
2531(...coming soon...)
2632
27- * Julia [ style guide] [ julia-style-guide ] .
33+ * Julia [ style guide] [ julia-style-guide ] .
2834
2935
3036#### Python
3137
3238(...coming soon...)
3339
34- * [ PEP 8] ( https://www.python.org/dev/peps/pep-0008/ )
40+ * [ PEP 8] ( https://www.python.org/dev/peps/pep-0008/ )
3541
3642
3743#### Go
@@ -43,23 +49,23 @@ When contributing to this project, please follow the provided guidelines.
4349
4450(...coming soon...)
4551
46- * [ Core Guidelines] ( https://github.com/isocpp/CppCoreGuidelines )
47- * [ FAQ] ( http://www.stroustrup.com/bs_faq2.html )
48- * [ cppdoc] ( http://www.edparrish.net/common/cppdoc.html )
49- * [ cpm] ( https://github.com/iauns/cpm )
50- - can also be used for C packages
52+ * [ Core Guidelines] ( https://github.com/isocpp/CppCoreGuidelines )
53+ * [ FAQ] ( http://www.stroustrup.com/bs_faq2.html )
54+ * [ cppdoc] ( http://www.edparrish.net/common/cppdoc.html )
55+ * [ cpm] ( https://github.com/iauns/cpm )
56+ - can also be used for C packages
5157
5258
5359#### C
5460
5561(...coming soon...)
5662
57- * [ clib] ( https://github.com/clibs/clib )
58- * [ package.json] ( https://github.com/clibs/clib/wiki/Explanation-of-package.json )
59- * [ packages] ( https://github.com/clibs/clib/wiki/Packages )
60- * [ list] ( https://github.com/clibs/list )
61- * [ levenshtein.c] ( https://github.com/wooorm/levenshtein.c )
62- * [ freebsd] ( https://www.freebsd.org/cgi/man.cgi?query=style&sektion=9 )
63+ * [ clib] ( https://github.com/clibs/clib )
64+ * [ package.json] ( https://github.com/clibs/clib/wiki/Explanation-of-package.json )
65+ * [ packages] ( https://github.com/clibs/clib/wiki/Packages )
66+ * [ list] ( https://github.com/clibs/list )
67+ * [ levenshtein.c] ( https://github.com/wooorm/levenshtein.c )
68+ * [ freebsd] ( https://www.freebsd.org/cgi/man.cgi?query=style&sektion=9 )
6369
6470
6571
@@ -74,23 +80,29 @@ When contributing to this project, please follow the provided guidelines.
7480
7581
7682---
83+
7784## Git
7885
79- * All commits should follow the [ seven rules] [ git-seven-rules ] of a ` git ` commit message:
80- - Use the [ imperative mood] [ imperative-mood ] in the ` git ` commit subject line.
81- - Capitalize the first word of the subject line.
82- - Do __ not__ end the subject line with a period.
83- - Separate the subject line from the body with a blank line.
84- - Try to limit the subject line to ` 50 ` characters.
85- - Use the body to explain the * what* and * why* , and not the * how* .
86- - Try to wrap the body at ` 72 ` characters.
86+ * All commits should follow the [ seven rules] [ git-seven-rules ] of a ` git ` commit message:
87+ - Use the [ imperative mood] [ imperative-mood ] in the ` git ` commit subject line.
88+ - Capitalize the first word of the subject line.
89+ - Do __ not__ end the subject line with a period.
90+ - Separate the subject line from the body with a blank line.
91+ - Try to limit the subject line to ` 50 ` characters.
92+ - Use the body to explain the * what* and * why* , and not the * how* .
93+ - Try to wrap the body at ` 72 ` characters.
8794
8895
8996
9097
9198<!-- <links> -->
99+
100+ [ code-of-conduct ] : https://github.com/stdlib-js/stdlib/blob/master/.github/CODE_OF_CONDUCT.md
101+ [ license ] : https://github.com/stdlib-js/stdlib/blob/master/LICENSE
102+
92103[ git-seven-rules ] : http://chris.beams.io/posts/git-commit/
93104[ imperative-mood ] : https://en.wikipedia.org/wiki/Imperative_mood
94105
95106[ julia-style-guide ] : http://docs.julialang.org/en/release-0.4/manual/style-guide/
107+
96108<!-- </links> -->
0 commit comments