diff --git a/README.md b/README.md index 49c8af6..0e9ec7b 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,53 @@ -# Google Style Guides +# 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. ✨ -β€œStyle” covers a lot of ground, from β€œuse camelCase for variable names” to -β€œnever use global variables” to β€œnever use exceptions.” This project +β€œ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](https://github.com/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. +πŸ‘‡ Here are some of the style guides provided: -* [AngularJS Style Guide][angular] -* [Common Lisp Style Guide][cl] -* [C++ Style Guide][cpp] -* [C# Style Guide][csharp] -* [Go Style Guide][go] -* [HTML/CSS Style Guide][htmlcss] -* [JavaScript Style Guide][js] -* [Java Style Guide][java] -* [Objective-C Style Guide][objc] -* [Python Style Guide][py] -* [R Style Guide][r] -* [Shell Style Guide][sh] -* [Swift Style Guide][swift] -* [TypeScript Style Guide][ts] -* [Vim script Style Guide][vim] +* [AngularJS Style Guide][angular] πŸ…°οΈ +* [Common Lisp Style Guide][cl] πŸͺ™ +* [C++ Style Guide][cpp] πŸ–₯️ +* [C# Style Guide][csharp] πŸ€– +* [Go Style Guide][go] πŸš€ +* [HTML/CSS Style Guide][htmlcss] 🌐 +* [JavaScript Style Guide][js] πŸ“œ +* [Java Style Guide][java] β˜• +* [Objective-C Style Guide][objc] 🍎 +* [Python Style Guide][py] 🐍 +* [R Style Guide][r] πŸ“Š +* [Shell Style Guide][sh] 🐚 +* [Swift Style Guide][swift] 🏎️ +* [TypeScript Style Guide][ts] 🌐 +* [Vim script Style Guide][vim] βœ’οΈ -This project also contains [cpplint][cpplint], a tool to assist with style guide -compliance, and [google-c-style.el][emacs], an Emacs settings file for Google +This project also contains [cpplint][cpplint] πŸš€, a tool to assist with style guide +compliance, and [google-c-style.el][emacs] πŸ“, 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][xml] may be helpful. In addition to actual +[XML Document Format Style Guide][xml] πŸ“„ 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/][ccl] for more details. +[https://creativecommons.org/licenses/by/3.0/][ccl] for more details. πŸ“œ The following Google style guide lives outside of this project: -[Effective Dart][dart]. +[Effective Dart][dart] 🎯 -## Contributing +## 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 @@ -55,7 +56,7 @@ 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. +changes, but we are primarily optimizing for Google's internal needs. 🚧 Creative Commons License