reduce side margins on smaller screens
1 file changed
tree: 26229ec886117a4397fbcc948b4f7ef5f18e9775
  1. .github/
  2. _includes/
  3. _sass/
  4. assets/
  5. docguide/
  6. go/
  7. include/
  8. _config.yml
  9. angularjs-google-style.html
  10. CODE_OF_CONDUCT.md
  11. cppguide.html
  12. cppguide.xml
  13. csharp-style.md
  14. eclipse-cpp-google-style.xml
  15. eclipse-java-google-style.xml
  16. favicon.ico
  17. google-c-style.el
  18. google-r-style.html
  19. google_python_style.vim
  20. htmlcssguide.html
  21. htmlcssguide.xml
  22. intellij-java-google-style.xml
  23. javaguide.css
  24. javaguide.html
  25. javaguidelink.png
  26. javascriptguide.xml
  27. jsguide.html
  28. jsoncstyleguide.html
  29. jsoncstyleguide.xml
  30. jsoncstyleguide_example_01.png
  31. jsoncstyleguide_example_02.png
  32. LICENSE
  33. lispguide.xml
  34. objcguide.md
  35. objcguide.xml
  36. pyguide.md
  37. pylintrc
  38. README.md
  39. Rguide.md
  40. Rguide.xml
  41. shell.xml
  42. shell.xsl
  43. shellguide.md
  44. styleguide.css
  45. styleguide.xsl
  46. tsguide.html
  47. vimscriptfull.xml
  48. vimscriptguide.xml
  49. xmlstyle.html
README.md

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 also contains google-c-style.el, an Emacs settings file for Google style.

We used to host the cpplint tool, but we stopped making internal updates public. An open source community has forked the project, so users are encouraged to use https://github.com/cpplint/cpplint instead.

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 guide lives outside of this project:

Since projects are largely maintained in a VCS, writing good commit messages is important to long term project health. Please refer to How to Write a Git Commit Message as an excellent resource. While it explicitly refers to the Git SCM, its principles apply to any system, and many Git conventions are trivial to translate to others.

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.

People can file issues using the GitHub tracker. 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.