Skip to content

Commit

Permalink
Исправление "коментариев" на "комментарии" по тексту
Browse files Browse the repository at this point in the history
Со второй буквой М ровно в два раза лучше
  • Loading branch information
realbigest authored and Morganov committed Dec 13, 2019
1 parent ec06a91 commit 03d295f
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion book/05-distributed-git/sections/contributing.asc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ image::images/git-diff-check.png[Вывод команды `git diff --check`.]

Далее, постарайтесь делать коммит логически разделенного набора изменений.
Если возможно, попытайтесь делать ваши изменения легко понятными - не нужно писать код все выходные, работая над пятью разными задачами, а в понедельник отправлять результат как один большой коммит.
Даже если вы не делали коммиты на выходных, то в понедельник используйте область подготовленных файлов для того, чтобы разделить проделанную работу по принципу минимум один коммит на задачу, давая полезные коментарии к каждому из них.
Даже если вы не делали коммиты на выходных, то в понедельник используйте область подготовленных файлов для того, чтобы разделить проделанную работу по принципу минимум один коммит на задачу, давая полезные комментарии к каждому из них.
Если несколько изменений касаются одного файла, используйте `git add --patch` для частичного добавления файлов в индекс (детально описано в <<ch07-git-tools#r_interactive_staging>>).
Состояние проекта в конце ветки не зависит от количества сделанных вами коммитов, так как все изменения добавятся в один момент, поэтому постарайтесь облегчить задачу вашим коллегам, когда они будут просматривать ваши изменения.
Такой подход так же облегчает ивлечение или отмену отдельных изменений, если это вдруг потребуется в будущем.
Expand Down
42 changes: 21 additions & 21 deletions book/06-github/sections/2-contributing.asc
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,9 @@ image::images/blink-04-pr-comment.png[Комментирование строк
.Комментарии, отправленные по электронной почте
image::images/blink-04-email.png[Уведомление по электронной почте]

Кто угодно может оставлять коментарии к запросу на слияние.
На <<r_pr_discussion>> можно увидеть пример, где владелец проекта оставил коментарии как к строке кода, так и в основной секции обсуждения.
Как вы могли заметить, коментарии к коду так же приведены в виде обсуждения.
Кто угодно может оставлять комментарии к запросу на слияние.
На <<r_pr_discussion>> можно увидеть пример, где владелец проекта оставил комментарии как к строке кода, так и в основной секции обсуждения.
Как вы могли заметить, комментарии к коду так же приведены в виде обсуждения.

[[r_pr_discussion]]
.Страница обсуждения запроса на слияние
Expand All @@ -166,7 +166,7 @@ image::images/blink-05-general-comment.png[Страница обсуждения
Используя почту, вам потребуется заново отправить свои изменения в список рассылки, а при использовании GitHub вы просто делаете коммит в тематическую ветку и повторяете push.

Когда контрибьютор сделает это, владелец проекта снова получит уведомление, а на странице запроса будет отмечено, что проблема решена.
Фактически, как только строка кода имеющая коментарий будет изменена, GitHub заметит это и удалит устаревшее отличие.
Фактически, как только строка кода имеющая комментарий будет изменена, GitHub заметит это и удалит устаревшее отличие.

[[r_pr_final]]
.Финальная стадия запроса на слияние
Expand Down Expand Up @@ -294,7 +294,7 @@ image::images/pr-02-merge-fix.png[PR fixed]
Давайте начнём с перекрестных ссылок для запросов слияния или проблем.
Всем запросам слияния и проблемам присваиваются уникальные номера в пределах проекта.
Например, у вас не может быть запроса на слияние с номером #3 и проблемы с номером #3.
Если вы хотите сослаться на любой запрос слияния или проблему из другого места, просто добавьте `#<num>` в коментарий или описание.
Если вы хотите сослаться на любой запрос слияния или проблему из другого места, просто добавьте `#<num>` в комментарий или описание.
Так же можно указывать более конкретно, если проблема или запрос слияния находятя где-то ещё; пишите `username#<num>` если ссылаетесь на проблему или запрос слияния, находящиеся в ответвленном репозитории, или `username/repo#<num>` если ссылаетесь на другой репозиторий.

Рассмотрим это на примере.
Expand Down Expand Up @@ -323,16 +323,16 @@ image::images/mentions-02-render.png[Отображение перекрестн
image::images/mentions-03-closed.png[Отображение перекрестных ссылок в закрытом запросе слияния]

Кроме идентификационных номеров, можно ссылаться на конкретный коммит используя SHA-1.
Следует указывать полный 40 символный хэш SHA-1, но если GitHub увидит его в коментарии, то автоматически подставит ссылку на коммит.
Следует указывать полный 40 символный хэш SHA-1, но если GitHub увидит его в комментарии, то автоматически подставит ссылку на коммит.
Как было сказано выше, вы можете ссылаться на коммиты как в других, так и в ответвленных репозиториях точно так же как делали это с Проблемами.

==== Разметка

Ссылки на другие Проблемы -- это лишь часть интереснейших вещей, которые вы можете делать в текстовых полях на GitHub.
Для Проблемы или запроса слияния в полях описания, коментария, коментария кода и других вы можете использовать так называемую ``Дополненную разметку GitHub''.
Для Проблемы или запроса слияния в полях описания, комментария, комментария кода и других вы можете использовать так называемую ``Дополненную разметку GitHub''.
Разметка похожа на обычный текст, который основательно преобразуется.

Смотрите <<r_example_markdown>> для примера как использовать разметку при написании коментариев и текста.
Смотрите <<r_example_markdown>> для примера как использовать разметку при написании комментариев и текста.

[[r_example_markdown]]
.Пример написания и отображения текста с разметкой.
Expand All @@ -341,7 +341,7 @@ image::images/markdown-01-example.png[Пример разметки]
===== Дополненная разметка GitHub

GitHub расширил возможности обычной разметки.
Эти возможности могут быть очень полезными при создании запросов слияния или коментариев и описаний к проблемам.
Эти возможности могут быть очень полезными при создании запросов слияния или комментариев и описаний к проблемам.

====== Список задач

Expand All @@ -361,11 +361,11 @@ GitHub расширил возможности обычной разметки.
Если добавить этот список в описание запроса на слияние или проблемы, то он будет отображен следующим образом <<r_task_lists>>

[[r_task_lists]]
.Отображение списка задач в коментарии.
.Отображение списка задач в комментарии.
image::images/markdown-02-tasks.png[Пример списка задач]

Он часто используется в запросах на слияние для отображения списка того, что вы хотите сделать до того, как запрос будет готов к слиянию.
Вы можете просто кликнуть по флажку, чтобы обновить коментарий -- не нужно редактировать коментарий вручную, чтобы пометить задачу как выполненную.
Вы можете просто кликнуть по флажку, чтобы обновить комментарий -- не нужно редактировать комментарий вручную, чтобы пометить задачу как выполненную.

Так же GitHub ищет списки задач в запросах на слияние и проблемах и отображает их как метаданные на страницах, где они упоминаются.
Например, если в вашем запросе на слияние есть задачи и вы просматриваете список всех запросов, то можно увидеть на сколько готов каждый из них.
Expand All @@ -380,7 +380,7 @@ image::images/markdown-03-task-summary.png[Пример списка задач]

====== Отрывки кода

В коментарии так же можно вставлять отрывки кода.
В комментарии так же можно вставлять отрывки кода.
Это особенно полезно когда вы хотите показать что-нибудь, что вы _собираетесь_ попробовать сделать, до того, как включить это в вашу ветку.
Так же часто применяется для добавления примеров кода, который не работает или мог быть добавлен в запрос на слияние.

Expand All @@ -405,9 +405,9 @@ image::images/markdown-04-fenced-code.png[Отображение обрамле

====== Цитирование

Если вы отвечаете только на часть большого коментария, то можно цитировать только выбранную часть, предваряя её символом `>`.
Если вы отвечаете только на часть большого комментария, то можно цитировать только выбранную часть, предваряя её символом `>`.
Это на столько часто используется, что даже существует комбинация клавиш для этого.
Если в коментарии выделить текст, на который вы собираетесь ответить, и нажать клавишу `r`, то выделенный текст будет включен как цитата в ваш коментарий.
Если в комментарии выделить текст, на который вы собираетесь ответить, и нажать клавишу `r`, то выделенный текст будет включен как цитата в ваш комментарий.

Цитаты выглядят примерно так:

Expand All @@ -419,7 +419,7 @@ image::images/markdown-04-fenced-code.png[Отображение обрамле
How big are these slings and in particular, these arrows?
----

После обработки коментарий будет выглядеть как <<r_md_quote>>.
После обработки комментарий будет выглядеть как <<r_md_quote>>.

[[r_md_quote]]
.Пример отображения цитаты.
Expand All @@ -428,15 +428,15 @@ image::images/markdown-05-quote.png[Отображение цитаты]
====== Смайлики

Наконец, вы можете использовать смайлики.
На GitHub вы можете часто встретить их в коментариях или запросах на слияние.
На GitHub вы можете часто встретить их в комментариях или запросах на слияние.
Для них есть даже помощник.
Когда вы пишите коментарий и начинаете слов с символа `:`, то вам будут предложены варианты автодополнения.
Когда вы пишите комментарий и начинаете слов с символа `:`, то вам будут предложены варианты автодополнения.

[[r_md_emoji_auto]]
.Автодополнение для смайлов в действии.
image::images/markdown-06-emoji-complete.png[Помощник по смайлам]

Смайлы имеют вид `:<name>:` и могут располагаться в любом месте коментария.
Смайлы имеют вид `:<name>:` и могут располагаться в любом месте комментария.
Например, вы можете написать что-нибудь вроде этого:

[source]
Expand All @@ -450,10 +450,10 @@ I :eyes: that :bug: and I :cold_sweat:.
:clap::tada::panda_face:
----

Такой коментарий будет выглядеть как на <<r_md_emoji>>.
Такой комментарий будет выглядеть как на <<r_md_emoji>>.

[[r_md_emoji]]
.Перегруженный смайликами коментарий.
.Перегруженный смайликами комментарий.
image::images/markdown-07-emoji.png[Смайлики]

Не то чтобы это невероятно полезно, но добавляет немного веселья и эмоций там, где трудно выразить какие-то эмоции.
Expand All @@ -469,7 +469,7 @@ http://www.emoji-cheat-sheet.com
====== Картинки

Технически, картинки не относятся к разметке GitHub, но их использование очень полезно.
В дополнение к ссылкам на картинки в коментариях, GitHub позволяет встраивать картинки в коментарии.
В дополнение к ссылкам на картинки в комментариях, GitHub позволяет встраивать картинки в комментарии.

[[r_md_drag]]
.Перетаскивание картинки для загрузки и встраивания.
Expand Down
Loading

0 comments on commit 03d295f

Please sign in to comment.