Skip to content

Commit 8aab535

Browse files
kwalrathkwalrath
authored
Add Dart style guide
* Added Go while I was in there. (@rakyll or @adg might have feedback on the link I used) * Rewrote things a bit to make the new links fit. * Copy edited a bit because I couldn't help myself.
1 parent 142b0e6 commit 8aab535

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

‎README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,31 @@ easier to understand a large codebase when all the code in it is in a
77
consistent style.
88

99
“Style” covers a lot of ground, from “use camelCase for variable names” to
10-
“never use global variables” to “never use exceptions.” This project holds the
10+
“never use global variables” to “never use exceptions.” This project
11+
([google/styleguide](https://github.com/google/styleguide)) links to the
1112
style guidelines we use for Google code. If you are modifying a project that
1213
originated at Google, you may be pointed to this page to see the style guides
1314
that apply to that project.
1415

15-
Our [C++ Style Guide][cpp], [Objective-C Style Guide][objc], [Java Style
16-
Guide][java], [Python Style Guide][py], [R Style Guide][r], [Shell Style
17-
Guide][sh], [HTML/CSS Style Guide][htmlcss], [JavaScript Style Guide][js],
18-
[AngularJS Style Guide][angular], [Common Lisp Style Guide][cl], and [Vimscript
19-
Style Guide][vim] are now available. We have also released [cpplint][cpplint],
20-
a tool to assist with style guide compliance, and [google-c-style.el][emacs],
21-
an Emacs settings file for Google style.
16+
This project holds the [C++ Style Guide][cpp], [Objective-C Style Guide][objc],
17+
[Java Style Guide][java], [Python Style Guide][py], [R Style Guide][r],
18+
[Shell Style Guide][sh], [HTML/CSS Style Guide][htmlcss],
19+
[JavaScript Style Guide][js], [AngularJS Style Guide][angular],
20+
[Common Lisp Style Guide][cl], and [Vimscript Style Guide][vim]. This project
21+
also contains [cpplint][cpplint], a tool to assist with style guide compliance,
22+
and [google-c-style.el][emacs], an Emacs settings file for Google style.
2223

23-
If your project requires that you create a new XML document format, our [XML
24+
If your project requires that you create a new XML document format, the [XML
2425
Document Format Style Guide][xml] may be helpful. In addition to actual style
2526
rules, it also contains advice on designing your own vs. adapting an existing
2627
format, on XML instance document formatting, and on elements vs. attributes.
2728

28-
These style guides are licensed under the CC-By 3.0 License, which encourages
29-
you to share these documents. See [https://creativecommons.org/licenses/by/3.0/](https://creativecommons.org/licenses/by/3.0/)
30-
for more details.
29+
The style guides in this project are licensed under the CC-By 3.0 License,
30+
which encourages you to share these documents.
31+
See [https://creativecommons.org/licenses/by/3.0/][ccl] for more details.
32+
33+
The following Google style guides live outside of this project:
34+
[Go Style][go] and [Effective Dart][dart].
3135

3236
<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>
3337

@@ -45,3 +49,6 @@ for more details.
4549
[cpplint]: https://github.com/google/styleguide/tree/gh-pages/cpplint
4650
[emacs]: https://raw.githubusercontent.com/google/styleguide/gh-pages/google-c-style.el
4751
[xml]: https://google.github.io/styleguide/xmlstyle.html
52+
[dart]: https://www.dartlang.org/guides/language/effective-dart
53+
[go]: https://github.com/golang/go/wiki/Style
54+
[ccl]: https://creativecommons.org/licenses/by/3.0/

0 commit comments

Comments
 (0)