mirror of
https://github.com/google/styleguide.git
synced 2024-03-22 13:11:43 +08:00
Link to the Go style guide from README.md.
This commit is contained in:
parent
317af043a9
commit
8828cd1a63
75
README.md
75
README.md
|
@ -2,49 +2,61 @@
|
|||
|
||||
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.
|
||||
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](https://github.com/google/styleguide)) links to the
|
||||
style guidelines we use for Google code. If you are modifying a project that
|
||||
([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.
|
||||
|
||||
This project holds the [C++ Style Guide][cpp], [C# Style Guide][csharp],
|
||||
[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.
|
||||
This project holds the following style guides:
|
||||
|
||||
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 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.
|
||||
* [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]
|
||||
* [Vimscript Style Guide][vim]
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
The following Google style guides live outside of this project:
|
||||
[Go Code Review Comments][go] and [Effective Dart][dart].
|
||||
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
|
||||
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
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
<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
|
||||
[swift]: https://google.github.io/swift/
|
||||
[objc]: objcguide.md
|
||||
[go]: go/
|
||||
[java]: https://google.github.io/styleguide/javaguide.html
|
||||
[py]: https://google.github.io/styleguide/pyguide.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
|
||||
[emacs]: https://raw.githubusercontent.com/google/styleguide/gh-pages/google-c-style.el
|
||||
[xml]: https://google.github.io/styleguide/xmlstyle.html
|
||||
[go]: https://golang.org/wiki/CodeReviewComments
|
||||
[dart]: https://www.dartlang.org/guides/language/effective-dart
|
||||
[ccl]: https://creativecommons.org/licenses/by/3.0/
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user