ShuriZma
/
xenia
mirror of https://github.com/xenia-project/xenia.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #598 from jakehamilton/update-style-guide 

Fix dead links to Google style guide
This commit is contained in:
Justin Moore 2016-07-07 09:24:55 -05:00 committed by GitHub
parent 3d1d4dea47 4cb18a99fe
commit 99f3c61fc1
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/style_guide.md
View File

@ -1,7 +1,7 @@
# Style Guide # Style Guide
The style guide can be summed up as 'clang-format with the Google style set'. The style guide can be summed up as 'clang-format with the Google style set'.
In addition, the [Google Style Guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) In addition, the [Google Style Guide](https://google.github.io/styleguide/cppguide.html)
is followed and cpplint is the source of truth. When in doubt, defer to what is followed and cpplint is the source of truth. When in doubt, defer to what
code in the project already does. code in the project already does.
@ -10,8 +10,8 @@ Base rules:
* 80 column line length max * 80 column line length max
* LF (Unix-style) line endings * LF (Unix-style) line endings
* 2-space soft tabs, no TABs! * 2-space soft tabs, no TABs!
* [Google Style Guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) for naming/casing/etc * [Google Style Guide](https://google.github.io/styleguide/cppguide.html) for naming/casing/etc
* Sort includes according to the [style guide rules](http://google-styleguide.googlecode.com/svn/trunk/cppguide.html#Names_and_Order_of_Includes) * Sort includes according to the [style guide rules](https://google.github.io/styleguide/cppguide.html#Names_and_Order_of_Includes)
* Comments are properly punctuated (that means capitalization and periods, etc) * Comments are properly punctuated (that means capitalization and periods, etc)
* TODO's must be attributed like `// TODO(yourgithubname): foo.` * TODO's must be attributed like `// TODO(yourgithubname): foo.`
@ -21,7 +21,7 @@ lines.
### Why? ### Why?
To quote the [Google Style Guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml): To quote the [Google Style Guide](https://google.github.io/styleguide/cppguide.html):
``` ```
One way in which we keep the code base manageable is by enforcing consistency. One way in which we keep the code base manageable is by enforcing consistency.