Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md for easy undersanding #788

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 27 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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. 🚧

<a rel="license" href="https://creativecommons.org/licenses/by/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png" /></a>

Expand Down