From f06f2a274a57744ec1ee6cd97d9a0d43b2a56e10 Mon Sep 17 00:00:00 2001 From: cgarciaromaguera <73908697+cgarciaromaguera@users.noreply.github.com> Date: Sun, 12 Feb 2023 16:25:17 -0500 Subject: [PATCH 1/2] Update README.md 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. --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 49c8af6c7..6147ec415 100644 --- a/README.md +++ b/README.md @@ -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 From 21858d0d6bf51f05cf5aa7bf104a84299e021e84 Mon Sep 17 00:00:00 2001 From: cgarciaromaguera <73908697+cgarciaromaguera@users.noreply.github.com> Date: Sun, 12 Feb 2023 16:36:30 -0500 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 6147ec415..7b51fe6dd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ # 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 easier to understand a large codebase when all the code in it is in a consistent @@ -14,6 +16,8 @@ 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