Внесение изменений в документы

Принимаются корректировки опечаток

Зарегистрируйтесь на GitHub (если вы еще этого не сделали).
Откройте в браузере документ, в который собираетесь внести изменения (например этот)
Нажмите кнопку редактирования
В открышемся редакторе внесите изменения в файл. Вы всегда можете переключиться между режимом редактирования и предпросмотра кнопками Edit File и Preview Changes

Для написания документов используется облегченный язык разметки Markdown. Если Вы с ним не знакомы, ознакомьтесь со специальным руководством

Создайте новую ветку, дайте ей название и отправьте изменения:

На открывшейся странице нажмите Create pull request, после чего создастся запрос на изменение. В рамках запроса будет проведена автоматическая проверка корректности получившейся разметки и доступности всех ссылок. После подтверждения запроса изменения попадут в основную ветку и будут доступны всем.

Оформление зарпосов на изменение

Ветки

Ветки желательно создавать от main, в названии ветки укажите файл, в который вносятся изменения.

Коммиты

В описании к коммиту желательно указать краткое резюме о вносимых изменениях.

Markdown Style

Все документы проверяются на существование всех присутствующих ссылок при помощи markdown-link-check. Проверка происходит при создании Pull Request'а в ветку main, информация о ходе проверки и о её результатах выводится на странице Pull Request'a

Если проверка не прошла

Необходимо проверить все ссылки в изменяемом документе, если хотя бы одна ведёт на несуществующий сайт, проверка не выполнится.

Подтверждение

Чтобы изменения вступили в силу, их должен проверить и одобрить Игорь Маслов или Юлия Царева.

Релиз изменений

Происходит автоматически после подтверждения изменений и их попадания в ветку main

4.1 KiB Raw Blame History Unescape Escape