styleguide README

The project's README from github.com/google/styleguide. As one markdown file: README.md.

Google Style Guides

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 style.

“Style” covers a lot of ground, from “use camelCase for variable names” to “never use global variables” to “never use exceptions.” This project (google/styleguide) links to the style 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.

This project also contains google-c-style.el, an Emacs settings file for Google style.

We used to host the cpplint tool, but we stopped making internal updates public. An open source community has forked the project, so users are encouraged to use https://github.com/cpplint/cpplint instead.

If your project requires that you create a new XML document format, the XML Document Format Style Guide 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.

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/ for more details.

The following Google style guide lives outside of this project:

Since projects are largely maintained in a VCS, writing good commit messages is important to long term project health. Please refer to How to Write a Git Commit Message as an excellent resource. While it explicitly refers to the Git SCM, its principles apply to any system, and many Git conventions are trivial to translate to others.

Contributing

With few exceptions, these style guides are copies of Google's internal style guides to assist developers working on Google owned and originated open source projects. Changes to the style guides are made to the internal style guides first and eventually copied into the versions found here. External contributions are not accepted. Pull requests are regularly closed without comment.

People can file issues using the GitHub tracker. Issues that raise questions, justify changes on technical merits, or point out obvious mistakes may get some engagement and could in theory lead to changes, but we are primarily optimizing for Google's internal needs.

Creative Commons License

styleguide (google/styleguide)

Searching Database…

39.7K ·GitHub
Styleguide
Что это такое?Это собрание руководств по стилю, которые Google использует для своего кода и для открытого кода, созданного в Google. Охватывает такие языки, как C++, Java, Python, Go, JavaScript, TypeScript, HTML/CSS, Shell, Swift и другие.
Это инструмент или просто документация?Это чистая документация: набор связанных страниц руководств в формате markdown/HTML, а также один файл настроек Emacs для автоматического применения стиля C++ от Google.
Как устроена эта коллекция?README по сути представляет собой оглавление со ссылками на отдельные руководства по языкам (AngularJS, C++, C#, Go, HTML/CSS, Java, JavaScript, JSON, Markdown, Objective-C, Python, R, Shell, Swift, TypeScript, Vim script), а Effective Dart и руководство по Kotlin размещаются на внешних ресурсах.
Нужно ли мне что-то особенное для работы с cpplint?Нет, Google перестал поддерживать cpplint внутри компании и теперь направляет пользователей к форку, который поддерживается сообществом, а не размещает инструмент в этом репозитории.
А есть ли здесь что-то про стиль сообщений коммитов?Собственного правила для сообщений коммитов здесь нет, но рекомендуется широко цитируемая статья «How to Write a Git Commit Message» как полезный материал.
Есть ли руководство по форматам XML-документов?Да, есть руководство по стилю XML-документов, в котором описаны принципы проектирования, оформление экземпляров документа и различие между элементами и атрибутами.
Руководства по Dart и Kotlin хранятся прямо в этом репозитории?Нет, Effective Dart и Kotlin Style Guide ведутся на внешних ресурсах, а в этом проекте есть только ссылки на них.
What are similar projects?zh-google-styleguide, ruby-style-guide, api-guidelines, project-layout, guide, idiomatic.js, swift-style-guide, nodebestpractices
Which topics is it in?angularjs, styleguide, standards, vim script, style-guide, c-sharp, coding, best-practices, programming, c#, golang, reference
Creator
google
Size
4.1 MB
Stars
39.7K
Updated
CommitOct 17
Age
11y
Commits · 90 Days