mirror of
https://github.com/Tinkoff/career.git
synced 2026-01-27 04:40:44 +03:00
46 lines
4.0 KiB
Markdown
46 lines
4.0 KiB
Markdown
# Внесение изменений в документы
|
||
|
||
> Принимаются корректировки опечаток
|
||
|
||
- Зарегистрируйтесь на [GitHub](https://github.com/) (если вы еще этого не сделали).
|
||
|
||
- Откройте в браузере документ, в который собираетесь внести изменения (например [этот](https://github.com/Tinkoff/career/blob/main/interview/README.md))
|
||
|
||
- Нажмите кнопку редактирования 
|
||
|
||
- В открышемся редакторе внесите изменения в файл. Вы всегда можете переключиться между режимом редактирования и предпросмотра кнопками `Edit File` и `Preview Changes`
|
||
|
||
> Для написания документов используется облегченный язык разметки [Markdown](https://ru.wikipedia.org/wiki/Markdown). Если Вы с ним не знакомы, ознакомьтесь со специальным [руководством](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
|
||
|
||
- Создайте новую [ветку](https://github.com/Tinkoff/career/blob/main/CONTRIBUTING.md#ветки), дайте ей название и отправьте [изменения](https://github.com/Tinkoff/career/blob/main/CONTRIBUTING.md#коммиты):
|
||
|
||
|
||
|
||
- На открывшейся странице нажмите `Create pull request`, после чего создастся запрос на изменение. В рамках запроса будет проведена автоматическая [проверка](https://github.com/Tinkoff/career/blob/main/CONTRIBUTING.md#markdown-style) корректности получившейся разметки и доступности всех ссылок. После [подтверждения](https://github.com/Tinkoff/career/blob/main/CONTRIBUTING.md#подтверждение) запроса [изменения](https://github.com/Tinkoff/career/blob/main/CONTRIBUTING.md#релиз-изменений) попадут в основную ветку и будут доступны всем.
|
||
|
||
## Оформление запросов на изменение
|
||
|
||
### Ветки
|
||
|
||
Ветки желательно создавать от `main`, в названии ветки укажите файл, в который вносятся изменения.
|
||
|
||
### Коммиты
|
||
|
||
В описании к коммиту желательно указать краткое резюме о вносимых изменениях.
|
||
|
||
## Markdown Style
|
||
|
||
Все документы проверяются на существование всех присутствующих ссылок при помощи [markdown-link-check](https://github.com/tcort/markdown-link-check). Проверка происходит при создании Pull Request'а в ветку main, информация о ходе проверки и о её результатах выводится на странице Pull Request'a
|
||
|
||
### Если проверка не прошла
|
||
|
||
Необходимо проверить все ссылки в изменяемом документе, если хотя бы одна ведёт на несуществующий сайт, проверка не выполнится.
|
||
|
||
## Подтверждение
|
||
|
||
Чтобы изменения вступили в силу, их должен проверить и одобрить [Игорь Маслов](https://github.com/MaslovIgor) или [Юлия Царева](https://github.com/YuliaTsareva).
|
||
|
||
## Релиз изменений
|
||
|
||
Происходит автоматически после подтверждения изменений и их попадания в ветку `main`
|