StarMirror/styleguide
1
0
Fork 0
mirror of https://github.com/google/styleguide.git synced 2024-03-22 13:11:43 +08:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source 
Documentation updates to improve contributor's understanding and usage of the project. The project's README file could include subheadings to improve readability. An installation process should be implemented. Additionally, credits and badges should be added. These would attract contributors for the benefit of the project.
This commit is contained in:
cgarciaromaguera 2023-02-12 16:25:17 -05:00 committed by GitHub
parent f924e89a56
commit f06f2a274a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,4 +1,6 @@
# Google Style Guides
# Ad logo if applicable
// if headers are added, recommend using a table of contents
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
@ -12,6 +14,11 @@ 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.
# How to use the Project
//include how to change Google originated projects to intended style guide
// how to change style guides on Google
# Style Guides
* [AngularJS Style Guide][angular]
* [Common Lisp Style Guide][cl]
@ -33,12 +40,21 @@ 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.
# Installation/Run Process
// Add installation process
// Recommend description of installation process for different devices
# Additional Formats
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.
# License
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.
@ -79,3 +95,10 @@ changes, but we are primarily optimizing for Google's internal needs.
[xml]: https://google.github.io/styleguide/xmlstyle.html
[dart]: https://www.dartlang.org/guides/language/effective-dart
[ccl]: https://creativecommons.org/licenses/by/3.0/
# Badges
//include project badges
//inform developers on what they are doing
# Test
//include tests to see how style guides are implemented