Style guides for Google-originated open-source projects
Go to file
Gregory P. Smith 629edc1ca9
Merge pull request #683 from google/python_styleguide
Project import generated by Copybara.  Mostly modernizing to a 3.9+ Pythonisms. Some clarification on TypeVars.
2022-04-12 20:47:33 -07:00
.github add issue template 2021-04-12 08:53:25 -04:00
assets/css Hide “This site is open source. Improve this page.” footer 2020-02-28 11:03:30 -05:00
cpplint Update language to comply with Android's inclusive language guidance 2020-07-28 18:21:22 -07:00
docguide Merge pull request #478 from amanvell/patch-1 2019-10-08 10:19:02 +01:00
include Remove prettyprint from HTML/CSS Style Guide 2022-01-12 13:47:57 +00:00
angularjs-google-style.html Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
CODE_OF_CONDUCT.md use the 2.0 version of the Contributor Covenant, with modification 2021-04-19 15:28:07 -04:00
CODEOWNERS Add owners for the Java and Shell guides, and alphabetize the list. 2020-09-16 02:20:35 -07:00
cppguide.html Update the C++ style guide. 2021-10-20 09:17:56 -07:00
cppguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
csharp-style.md Remove more markdown that GitHub cannot handle 2020-06-04 15:05:36 +01:00
eclipse-cpp-google-style.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
eclipse-java-google-style.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
google_python_style.vim Project import generated by Copybara. 2019-12-30 13:53:39 -08:00
google-c-style.el Fix typos 2022-02-10 17:44:21 +02:00
google-r-style.html Redirect google-r-style.html to RGuide.html 2019-08-07 08:58:29 +01:00
htmlcssguide.html Add recommendation to avoid using !important 2022-01-13 14:29:39 +00:00
htmlcssguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
intellij-java-google-style.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
javaguide.css Update format for numbered sections and whitespace 2022-01-12 16:56:30 +00:00
javaguide.html Move a </p> around 2022-02-02 20:00:05 -08:00
javaguidelink.png Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
javascriptguide.xml Fix typos 2022-02-10 17:44:21 +02:00
jsguide.html Fix typos 2022-02-10 17:44:21 +02:00
jsoncstyleguide_example_01.png Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
jsoncstyleguide_example_02.png Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
jsoncstyleguide.html Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
jsoncstyleguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
LICENSE Add an Apache 2.0 license file. 2020-01-02 15:34:31 -08:00
lispguide.xml Fix typos 2022-02-10 17:44:21 +02:00
objcguide.md [objc] Update the Objective-C style guide 📜 2018-08-17 18:47:57 -07:00
objcguide.xml Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
pyguide.md Project import generated by Copybara. 2022-04-13 03:44:05 +00:00
pylintrc Project import generated by Copybara. 2021-01-26 00:38:44 +00:00
README.md Update README.md 2021-04-08 20:30:44 +00:00
Rguide.md Replace external R style guide 2019-07-17 21:28:05 -07:00
Rguide.xml Redirect to the HTML version of the R Style Guide 2019-08-07 08:53:53 +01:00
shell.xml Add an HTML>HEADER>META tag to redirect from the old to the new shell guide 2020-02-17 12:30:45 -08:00
shell.xsl Add a canonical link to update the URL for the Shell guide 2020-04-29 22:30:48 -07:00
shellguide.md Project import generated by Copybara. 2020-05-18 13:58:13 -07:00
styleguide.css Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00
styleguide.xsl Fix typos 2022-02-10 17:44:21 +02:00
tsguide.html remove the go-link 2021-01-22 21:32:51 -08:00
vimscriptfull.xml Fix typos 2022-02-10 17:44:21 +02:00
vimscriptguide.xml Fix typos 2022-02-10 17:44:21 +02:00
xmlstyle.html Revert "Project import generated by Copybara." 2018-01-30 12:36:50 -05:00

Google Style Guides

Every major open-source project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style.

“Style” covers a lot of ground, from “use camelCase for variable names” to “never use global variables” to “never use exceptions.” This project (google/styleguide) links to the style guidelines we use for Google code. If you are modifying a project that originated at Google, you may be pointed to this page to see the style guides that apply to that project.

This project holds the C++ Style Guide, C# Style Guide, Swift Style Guide, Objective-C Style Guide, Java Style Guide, Python Style Guide, R Style Guide, Shell Style Guide, HTML/CSS Style Guide, JavaScript Style Guide, TypeScript Style Guide, AngularJS Style Guide, Common Lisp Style Guide, and Vimscript Style Guide. This project also contains cpplint, a tool to assist with style guide compliance, and google-c-style.el, an Emacs settings file for Google style.

If your project requires that you create a new XML document format, the XML Document Format Style Guide may be helpful. In addition to actual style rules, it also contains advice on designing your own vs. adapting an existing format, on XML instance document formatting, and on elements vs. attributes.

The style guides in this project are licensed under the CC-By 3.0 License, which encourages you to share these documents. See https://creativecommons.org/licenses/by/3.0/ for more details.

The following Google style guides live outside of this project: Go Code Review Comments and Effective Dart.

Contributing

With few exceptions, these style guides are copies of Google's internal style guides to assist developers working on Google owned and originated open source projects. Changes to the style guides are made to the internal style guides first and eventually copied into the versions found here. External contributions are not accepted. Pull requests are regularly closed without comment. Issues that raise questions, justify changes on technical merits, or point out obvious mistakes may get some engagement and could in theory lead to changes, but we are primarily optimizing for Google's internal needs.

Creative Commons License