StarMirror/styleguide
1
0
Fork 0
mirror of https://github.com/google/styleguide.git synced 2024-03-22 13:11:43 +08:00
Code Issues Projects Releases Wiki Activity

Link to the Go style guide from README.md.

Browse Source
This commit is contained in:
Gaal Yahas 2022-11-17 21:10:21 +00:00
parent 317af043a9
commit 8828cd1a63
1 changed files with 43 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@ -2,49 +2,61 @@
Every major open-source project has its own style guide: a set of conventions 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 (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 easier to understand a large codebase when all the code in it is in a consistent
consistent style. style.
“Style” covers a lot of ground, from “use camelCase for variable names” to “Style” covers a lot of ground, from “use camelCase for variable names” to
“never use global variables” to “never use exceptions.” This project “never use global variables” to “never use exceptions.” This project
([google/styleguide](https://github.com/google/styleguide)) links to the ([google/styleguide](https://github.com/google/styleguide)) links to the style
style guidelines we use for Google code. If you are modifying a project that 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 originated at Google, you may be pointed to this page to see the style guides
that apply to that project. that apply to that project.
This project holds the [C++ Style Guide][cpp], [C# Style Guide][csharp], This project holds the following style guides:
[Swift Style Guide][swift], [Objective-C Style Guide][objc],
[Java Style Guide][java], [Python Style Guide][py], [R Style Guide][r],
[Shell Style Guide][sh], [HTML/CSS Style Guide][htmlcss],
[JavaScript Style Guide][js], [TypeScript Style Guide][ts], [AngularJS Style Guide][angular],
[Common Lisp Style Guide][cl], and [Vimscript 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 style.
If your project requires that you create a new XML document format, the [XML * [AngularJS Style Guide][angular]
Document Format Style Guide][xml] may be helpful. In addition to actual style * [Common Lisp Style Guide][cl]
rules, it also contains advice on designing your own vs. adapting an existing * [C++ Style Guide][cpp]
format, on XML instance document formatting, and on elements vs. attributes. * [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]
* [Vimscript Style Guide][vim]
The style guides in this project are licensed under the CC-By 3.0 License, This project also contains [cpplint][cpplint], a tool to assist with style guide
which encourages you to share these documents. compliance, and [google-c-style.el][emacs], an Emacs settings file for Google
See [https://creativecommons.org/licenses/by/3.0/][ccl] for more details. style.
The following Google style guides live outside of this project: If your project requires that you create a new XML document format, the
[Go Code Review Comments][go] and [Effective Dart][dart]. [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.
The following Google style guide lives outside of this project:
[Effective Dart][dart].
## Contributing ## Contributing
With few exceptions, these style guides are copies of Google's internal style guides With few exceptions, these style guides are copies of Google's internal style
to assist developers working on Google owned and originated open source projects. guides to assist developers working on Google owned and originated open source
Changes to the style guides are made to the internal style guides first and projects. Changes to the style guides are made to the internal style guides
eventually copied into the versions found here. **External contributions are first and eventually copied into the versions found here. **External
not accepted.** contributions are not accepted.** Pull requests are regularly closed without
Pull requests are regularly closed without comment. comment. Issues that raise questions, justify changes on technical merits, or
Issues that raise questions, justify changes on technical merits, point out obvious mistakes may get some engagement and could in theory lead to
or point out obvious mistakes may get some engagement and could in theory lead to changes, changes, but we are primarily optimizing for Google's internal needs.
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> <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>
@ -52,6 +64,7 @@ but we are primarily optimizing for Google's internal needs.
[csharp]: https://google.github.io/styleguide/csharp-style.html [csharp]: https://google.github.io/styleguide/csharp-style.html
[swift]: https://google.github.io/swift/ [swift]: https://google.github.io/swift/
[objc]: objcguide.md [objc]: objcguide.md
[go]: go/
[java]: https://google.github.io/styleguide/javaguide.html [java]: https://google.github.io/styleguide/javaguide.html
[py]: https://google.github.io/styleguide/pyguide.html [py]: https://google.github.io/styleguide/pyguide.html
[r]: https://google.github.io/styleguide/Rguide.html [r]: https://google.github.io/styleguide/Rguide.html
@ -65,7 +78,5 @@ but we are primarily optimizing for Google's internal needs.
[cpplint]: https://github.com/google/styleguide/tree/gh-pages/cpplint [cpplint]: https://github.com/google/styleguide/tree/gh-pages/cpplint
[emacs]: https://raw.githubusercontent.com/google/styleguide/gh-pages/google-c-style.el [emacs]: https://raw.githubusercontent.com/google/styleguide/gh-pages/google-c-style.el
[xml]: https://google.github.io/styleguide/xmlstyle.html [xml]: https://google.github.io/styleguide/xmlstyle.html
[go]: https://golang.org/wiki/CodeReviewComments
[dart]: https://www.dartlang.org/guides/language/effective-dart [dart]: https://www.dartlang.org/guides/language/effective-dart
[ccl]: https://creativecommons.org/licenses/by/3.0/ [ccl]: https://creativecommons.org/licenses/by/3.0/