| commit | 124b0b86836696a03cc5d11a902c80e8faa9082f | [log] [tgz] |
|---|---|---|
| author | Daniel Cheng <[email protected]> | Thu May 01 19:23:23 2025 |
| committer | Mike Frysinger <[email protected]> | Wed Jul 09 01:57:26 2025 |
| tree | be4e6bb6efb9406787c03fd584af19a8df5de076 | |
| parent | 1ab9120f856901f5cca56ca8947985628221b583 [diff] |
Add styling rules for good code examples in shared stylesheet This change primarily affects the C++ style guide: while a number of other style guides also use <pre> directly for code examples, the other style guides all use JS to prettyprint the code blocks, and the prettyprinter overrides the styles specified in the shared stylesheet. The exception is the AngularJS style guide, but it is already inconsistently formatted and this change does not make it any worse. There are also several other style guides other than C++ where good/neutral are rendered identically; this commit does not attempt to address those either.
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.
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.
