forked from Pissandshittium/pissandshittium
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] Move markdown style guide to chromium docs
It's currently hosted at [chromium project][1] page, which is difficult to find compared to other style guides listed here. Will submit another change to redirect from the existing page. [1]: https://www.chromium.org/developers/markdown-documentation/ Change-Id: Id00ebb7960e9d41e91d6623df9b2d512ee03677b Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/4302569 Commit-Queue: John Abd-El-Malek <jam@chromium.org> Reviewed-by: Kenichi Ishibashi <bashi@chromium.org> Reviewed-by: John Abd-El-Malek <jam@chromium.org> Auto-Submit: Ming-Ying Chung <mych@chromium.org> Cr-Commit-Position: refs/heads/main@{#1112579}
- Loading branch information
Showing
4 changed files
with
35 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Markdown Style Guide in Chromium | ||
|
||
## Style Guide | ||
|
||
Please write your Markdown file | ||
|
||
* In accordance with [Google Documentation | ||
Guide](https://github.com/google/styleguide/tree/gh-pages/docguide) | ||
* [Limit lines to **80 characters** where | ||
possible](https://groups.google.com/a/chromium.org/d/msg/chromium-dev/KECdEn562vY/sqRor1frEgAJ) | ||
|
||
Unfortunately, `git cl format` will NOT do this for you. | ||
|
||
## Documentation Guide | ||
|
||
New documentation related to code structure should be put in Markdown. The best | ||
practices recommendation is to put a `README.md` file in the code directory | ||
closest to your component or code. | ||
|
||
See [Chromium Documentation | ||
Guidelines](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/documentation_guidelines.md) | ||
for details. | ||
|
||
[Here are some | ||
examples](https://cs.chromium.org/search/?q=file:readme.md+-file:/third_party/) | ||
to learn from. | ||
|
||
## Making Changes | ||
|
||
See [Creating | ||
Documentation](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/README.md#creating-documentation). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters