Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cgarciaromaguera patch 1 #760

Open
wants to merge 3 commits into
base: gh-pages
Choose a base branch
from
Open

Cgarciaromaguera patch 1 #760

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f06f2a2
Update README.md
cgarciaromaguera Feb 12, 2023
9481092
Merge pull request #1 from cgarciaromaguera/cgarciaromaguera-document…
cgarciaromaguera Feb 12, 2023
21858d0
Update README.md
cgarciaromaguera Feb 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Google Style Guides
# Ad logo if applicable
// if headers are added, recommend using a table of contents

# 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
Expand All @@ -12,6 +16,13 @@ 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.

//if a project applies to other style guides how would this effect the contributor

# 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]
Expand All @@ -33,12 +44,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.
Expand Down Expand Up @@ -79,3 +99,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