Merge pull request #633 from elharo/patch-1

docs: discourage external contributors
tree: b1faee2caef476e15a0a7c527f5669a49b3f362f
  1. CODEOWNERS
  2. LICENSE
  3. README.md
  4. Rguide.md
  5. Rguide.xml
  6. angularjs-google-style.html
  7. assets/
  8. cppguide.html
  9. cppguide.xml
  10. cpplint/
  11. csharp-style.md
  12. docguide/
  13. eclipse-cpp-google-style.xml
  14. eclipse-java-google-style.xml
  15. google-c-style.el
  16. google-r-style.html
  17. google_python_style.vim
  18. htmlcssguide.html
  19. htmlcssguide.xml
  20. include/
  21. intellij-java-google-style.xml
  22. javaguide.css
  23. javaguide.html
  24. javaguidelink.png
  25. javascriptguide.xml
  26. jsguide.html
  27. jsoncstyleguide.html
  28. jsoncstyleguide.xml
  29. jsoncstyleguide_example_01.png
  30. jsoncstyleguide_example_02.png
  31. lispguide.xml
  32. objcguide.md
  33. objcguide.xml
  34. pyguide.md
  35. pylintrc
  36. shell.xml
  37. shell.xsl
  38. shellguide.md
  39. styleguide.css
  40. styleguide.xsl
  41. tsguide.html
  42. vimscriptfull.xml
  43. vimscriptguide.xml
  44. 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 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.