|
1 |
| -# Google Style Guides |
| 1 | +# JPG.store Style Guides |
| 2 | + |
| 3 | +### Adapted from Google's style guides |
2 | 4 |
|
3 | 5 | Every major open-source project has its own style guide: a set of conventions
|
4 | 6 | (sometimes arbitrary) about how to write code for that project. It is much
|
|
7 | 9 |
|
8 | 10 | “Style” covers a lot of ground, from “use camelCase for variable names” to
|
9 | 11 | “never use global variables” to “never use exceptions.” This project
|
10 |
| -([google/styleguide](https://github.com/google/styleguide)) links to the style |
| 12 | +([google/styleguide](https://github.com/jpg-store/styleguide)) links to the style |
11 | 13 | guidelines we use for Google code. If you are modifying a project that
|
12 | 14 | originated at Google, you may be pointed to this page to see the style guides
|
13 | 15 | that apply to that project.
|
14 | 16 |
|
15 |
| - |
16 |
| -* [AngularJS Style Guide][angular] |
17 |
| -* [Common Lisp Style Guide][cl] |
18 |
| -* [C++ Style Guide][cpp] |
19 |
| -* [C# Style Guide][csharp] |
20 |
| -* [Go Style Guide][go] |
21 |
| -* [HTML/CSS Style Guide][htmlcss] |
22 |
| -* [JavaScript Style Guide][js] |
23 |
| -* [Java Style Guide][java] |
24 |
| -* [Objective-C Style Guide][objc] |
25 |
| -* [Python Style Guide][py] |
26 |
| -* [R Style Guide][r] |
27 |
| -* [Shell Style Guide][sh] |
28 |
| -* [Swift Style Guide][swift] |
29 |
| -* [TypeScript Style Guide][ts] |
30 |
| -* [Vim script Style Guide][vim] |
31 |
| - |
32 |
| -This project also contains [cpplint][cpplint], a tool to assist with style guide |
33 |
| -compliance, and [google-c-style.el][emacs], an Emacs settings file for Google |
34 |
| -style. |
35 |
| - |
36 |
| -If your project requires that you create a new XML document format, the |
37 |
| -[XML Document Format Style Guide][xml] may be helpful. In addition to actual |
38 |
| -style rules, it also contains advice on designing your own vs. adapting an |
39 |
| -existing format, on XML instance document formatting, and on elements vs. |
40 |
| -attributes. |
| 17 | +- [Go Style Guide][go] |
| 18 | +- [HTML/CSS Style Guide][htmlcss] |
| 19 | +- [Python Style Guide][py] |
| 20 | +- [TypeScript Style Guide][ts] |
41 | 21 |
|
42 | 22 | The style guides in this project are licensed under the CC-By 3.0 License, which
|
43 | 23 | encourages you to share these documents. See
|
44 | 24 | [https://creativecommons.org/licenses/by/3.0/][ccl] for more details.
|
45 | 25 |
|
46 |
| -The following Google style guide lives outside of this project: |
47 |
| -[Effective Dart][dart]. |
48 |
| - |
49 | 26 | ## Contributing
|
50 | 27 |
|
51 |
| -With few exceptions, these style guides are copies of Google's internal style |
52 |
| -guides to assist developers working on Google owned and originated open source |
53 |
| -projects. Changes to the style guides are made to the internal style guides |
54 |
| -first and eventually copied into the versions found here. **External |
55 |
| -contributions are not accepted.** Pull requests are regularly closed without |
56 |
| -comment. Issues that raise questions, justify changes on technical merits, or |
57 |
| -point out obvious mistakes may get some engagement and could in theory lead to |
58 |
| -changes, but we are primarily optimizing for Google's internal needs. |
| 28 | +Please, feel free to contribute if you have any objections. |
59 | 29 |
|
60 | 30 | <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>
|
61 | 31 |
|
62 |
| -[cpp]: https://google.github.io/styleguide/cppguide.html |
63 |
| -[csharp]: https://google.github.io/styleguide/csharp-style.html |
64 |
| -[swift]: https://google.github.io/swift/ |
65 |
| -[objc]: objcguide.md |
66 | 32 | [go]: go/
|
67 |
| -[java]: https://google.github.io/styleguide/javaguide.html |
68 | 33 | [py]: https://google.github.io/styleguide/pyguide.html
|
69 |
| -[r]: https://google.github.io/styleguide/Rguide.html |
70 |
| -[sh]: https://google.github.io/styleguide/shellguide.html |
71 | 34 | [htmlcss]: https://google.github.io/styleguide/htmlcssguide.html
|
72 |
| -[js]: https://google.github.io/styleguide/jsguide.html |
73 | 35 | [ts]: https://google.github.io/styleguide/tsguide.html
|
74 |
| -[angular]: https://google.github.io/styleguide/angularjs-google-style.html |
75 |
| -[cl]: https://google.github.io/styleguide/lispguide.xml |
76 |
| -[vim]: https://google.github.io/styleguide/vimscriptguide.xml |
77 |
| -[cpplint]: https://github.com/google/styleguide/tree/gh-pages/cpplint |
78 |
| -[emacs]: https://raw.githubusercontent.com/google/styleguide/gh-pages/google-c-style.el |
79 |
| -[xml]: https://google.github.io/styleguide/xmlstyle.html |
80 |
| -[dart]: https://www.dartlang.org/guides/language/effective-dart |
81 |
| -[ccl]: https://creativecommons.org/licenses/by/3.0/ |
0 commit comments