chromium/src
0
Fork 0
Code Activity

documentation: Add link to markdown guide

Browse Source 
Change-Id: I5f5d014fad932c367d92f464c4573d22b311ea83
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3198385
Reviewed-by: Charlie Reis <creis@chromium.org>
Reviewed-by: Dirk Pranke <dpranke@google.com>
Commit-Queue: Jaeheon Yi <jaeheon@google.com>
Cr-Commit-Position: refs/heads/main@{#927404}
This commit is contained in:
Jaeheon Yi
2021-10-01 22:07:39 +00:00
committed by Chromium LUCI CQ
parent 589451c06c
commit 1990e58f63
1 changed files with 25 additions and 14 deletions

39
styleguide/styleguide.md

@ -2,25 +2,36 @@
## Main style guides
* [Chromium C++ style guide](c++/c++.md)
* See also: [C++ Dos and Don'ts](c++/c++-dos-and-donts.md) for Chromium best-practices.
* [Chromium Objective-C style guide](objective-c/objective-c.md)
* [Chromium Swift style guide](swift/swift.md)
* [Java style guide for Android](java/java.md)
* [Chromium Python style guide](python/python.md)
* [GN style guide](https://gn.googlesource.com/gn/+/master/docs/style_guide.md) for build files.
* See also: [Writing GN templates](../build/docs/writing_gn_templates.md) for Chromium best-practices.
* [Chromium C++ style guide](c++/c++.md)
* See also: [C++ Dos and Don'ts](c++/c++-dos-and-donts.md) for Chromium
best-practices.
* [Chromium Objective-C style guide](objective-c/objective-c.md)
* [Chromium Swift style guide](swift/swift.md)
* [Java style guide for Android](java/java.md)
* [Chromium Python style guide](python/python.md)
* [GN style guide](https://gn.googlesource.com/gn/+/main/docs/style_guide.md)
for build files.
* See also: [Writing GN templates](../build/docs/writing_gn_templates.md)
for Chromium best-practices.
* [Markdown guide](https://www.chromium.org/developers/markdown-documentation)
Chromium also uses these languages to a lesser degree:
* [Kernel C style](https://www.kernel.org/doc/html/latest/process/coding-style.html) for ChromiumOS firmware.
* [IDL](https://sites.google.com/a/chromium.org/dev/blink/webidl#TOC-Style)
* [Jinja style guide](https://sites.google.com/a/chromium.org/dev/developers/jinja#TOC-Style) for [Jinja](https://sites.google.com/a/chromium.org/dev/developers/jinja) templates.
* [Kernel C style](https://www.kernel.org/doc/html/latest/process/coding-style.html)
for ChromiumOS firmware.
* [IDL](https://sites.google.com/a/chromium.org/dev/blink/webidl#TOC-Style)
* [Jinja style guide](https://sites.google.com/a/chromium.org/dev/developers/jinja#TOC-Style)
for [Jinja](https://sites.google.com/a/chromium.org/dev/developers/jinja)
templates.
Regardless of the language used, please keep code [inclusive for all contributors](inclusive_code.md).
Regardless of the language used, please keep code
[inclusive for all contributors](inclusive_code.md).
## Web languages (JavaScript, HTML, CSS)
When working on Web-based UI features, consult the [Web Development Style Guide](web/web.md) for the Chromium conventions used in JS/CSS/HTML files.
When working on Web-based UI features, consult the
[Web Development Style Guide](web/web.md) for the Chromium conventions used in
JS/CSS/HTML files.
Internal uses of web languages, notably "layout" tests, should preferably follow these style guides, but it is not enforced.
Internal uses of web languages, notably "layout" tests, should preferably follow
these style guides, but it is not enforced.