Skip to content

Commit ff05004

Browse files
kgrytekgryte
committed
Add style guide stubs
1 parent 5926906 commit ff05004

File tree

9 files changed

+104
-0
lines changed

9 files changed

+104
-0
lines changed

‎docs/style-guides/bash/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Bash Style Guide
2+
===
3+
4+
> Style guide for bash.
5+
6+
7+
TODO
8+

‎docs/style-guides/c/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
C Style Guide
2+
===
3+
4+
> Style guide for programming in C.
5+
6+
7+
TODO
8+
9+
10+
* [clib](https://github.com/clibs/clib)
11+
* [package.json](https://github.com/clibs/clib/wiki/Explanation-of-package.json)
12+
* [packages](https://github.com/clibs/clib/wiki/Packages)
13+
* [list](https://github.com/clibs/list)
14+
* [levenshtein.c](https://github.com/wooorm/levenshtein.c)
15+
* [freebsd](https://www.freebsd.org/cgi/man.cgi?query=style&sektion=9)

‎docs/style-guides/cpp/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
C++ Style Guide
2+
===
3+
4+
> Style guide for programming in C++.
5+
6+
7+
TODO
8+
9+
10+
* [Core Guidelines](https://github.com/isocpp/CppCoreGuidelines)
11+
* [FAQ](http://www.stroustrup.com/bs_faq2.html)
12+
* [cppdoc](http://www.edparrish.net/common/cppdoc.html)
13+
* [cpm](https://github.com/iauns/cpm)
14+
- can also be used for C packages

‎docs/style-guides/git/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Git Style Guide
2+
===
3+
4+
> Style guide for git.
5+
6+
7+
* All commits should follow the [seven rules][git-seven-rules] of a `git` commit message:
8+
- Use the [imperative mood][imperative-mood] in the `git` commit subject line.
9+
- Capitalize the first word of the subject line.
10+
- Do __not__ end the subject line with a period.
11+
- Separate the subject line from the body with a blank line.
12+
- Try to limit the subject line to `50` characters.
13+
- Use the body to explain the *what* and *why*, and not the *how*.
14+
- Try to wrap the body at `72` characters.
15+
16+
17+
<!-- <links> -->
18+
19+
[git-seven-rules]: http://chris.beams.io/posts/git-commit/
20+
[imperative-mood]: https://en.wikipedia.org/wiki/Imperative_mood
21+
22+
<!-- </links> -->

‎docs/style-guides/go/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Go Style Guide
2+
===
3+
4+
> Style guide for programming in Go.
5+
6+
7+
TODO

‎docs/style-guides/julia/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Julia Style Guide
2+
===
3+
4+
> Style guide for programming in Julia.
5+
6+
7+
TODO
8+
9+
10+
* Julia [style guide](http://docs.julialang.org/en/release-0.4/manual/style-guide/).

‎docs/style-guides/make/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Make Style Guide
2+
===
3+
4+
> Style guide for Make.
5+
6+
7+
TODO

‎docs/style-guides/python/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Python Style Guide
2+
===
3+
4+
> Style guide for programming in Python.
5+
6+
7+
TODO
8+
9+
10+
* [PEP 8](https://www.python.org/dev/peps/pep-0008/)

‎docs/style-guides/r/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
R Style Guide
2+
===
3+
4+
> Style guide for programming in R.
5+
6+
7+
TODO
8+
9+
10+
* Google [style guide](https://google.github.io/styleguide/Rguide.xml)
11+
* Hadley's [notes](http://adv-r.had.co.nz/OO-essentials.html), which include a comment on `function` name conventions

0 commit comments

Comments
 (0)