eng-practices README

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

Google Engineering Practices Documentation

Google has many generalized engineering practices that cover all languages and all projects. These documents represent our collective experience of various best practices that we have developed over time. It is possible that open source projects or other organizations would benefit from this knowledge, so we work to make it available publicly when possible.

Currently this contains the following documents:

Terminology

There is some Google-internal terminology used in some of these documents, which we clarify here for external readers:

License

The documents 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.

Creative Commons License

eng-practices (google/eng-practices)

Searching Database…

23.3K ·GitHub
archived
Что это такое?Документация Google по инженерным практикам — публичная подборка руководств, в которых собраны инженерные практики, применяемые Google во всех языках и проектах. Сейчас основной упор сделан на её правилах ревью кода (Code Review Guidelines).
Это инструмент, который можно запустить, или просто документы для чтения?Просто документы, запускать нечего. В репозитории лежат правила ревью кода от Google, оформленные как два отдельных руководства: одно для ревьюеров, другое для авторов изменений.
Как её читать — нужно что-то устанавливать?Устанавливать ничего не нужно. Руководства — это обычный markdown в репозитории, а ещё они опубликованы как статический сайт на GitHub Pages, так что их можно просто открыть в браузере.
Проект ещё поддерживается?Нет. Репозиторий заархивирован и доступен только для чтения — сами руководства никуда не делись, но здесь они больше не обновляются.
Для кого написаны эти руководства?Прежде всего для инженеров Google — в некоторых документах встречаются внутренние термины Google вроде CL, которые README поясняет для внешних читателей. Но опубликованы они в том числе для того, чтобы их могли использовать проекты с открытым кодом и другие организации.
Можно ли делиться этими документами или использовать их у себя?Да — они распространяются по лицензии CC-By 3.0, которая, как прямо сказано в README, поощряет распространение.
Что означают CL и LGTM в этих документах?CL — это changelist (список изменений): одно самостоятельное изменение, отправленное в систему контроля версий или проходящее ревью кода — в других организациях его называют change, patch или pull request. LGTM расшифровывается как Looks Good to Me («меня всё устраивает») — так ревьюер говорит, когда одобряет CL.
Руководства для ревьюера и для автора — это разные документы?Да — Code Review Guidelines на самом деле состоят из двух отдельных наборов документов: The Code Reviewer's Guide и The Change Author's Guide, то есть у каждой стороны ревью своё руководство.
Creator
google
Size
0.1 MB
Stars
23.3K
Updated
CommitSep 19
Age
7y
Commits · 90 Days