Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

49 lines (27 loc) · 3.11 KB

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

Что предлагать

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

Мы рады предложениям по добавлению новых источников, актуализации существующих или удалению устаревший. Такие предложения оцениваются коллективом авторов, который оставляет за собой права отказать в принятии изменений.

Как предлагать

  • Зарегистрируйтесь на GitHub.

  • Откройте в браузере документ, в который собираетесь внести изменения.

  • Нажмите кнопку редактирования Edit this file.

  • В открывшемся редакторе внесите изменения в файл. Вы всегда можете переключиться между режимом редактирования и просмотра кнопками Edit и Preview.

  • Сохраните изменения, нажав Commit changes.

  • В открывшемся окне:

    • Напишите сообщение в поле Commit message;
    • Создайте новую ветку, выбрав Create a new branch for this commit and start a pull request;
    • Дайте название ветке.
  • Сохраните изменения через кнопку Propose changes.

  • На открывшейся странице нажмите Create pull request.

Ветки

Ветки создавать от main. В названии ветки укажите тип действия update и через дефис название изменяемого файла

Commit

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

Pull request

Изменения проверит кто-то из автора проекта. После одобрения изменения попадут в ветку main.

Markdown

Наши документы используют язык разметки Markdown. Если вы не работали в markdown, то быстро научитесь. Ознакомьтесь с синтаксисом.

GitHub Actions

Работоспособность ссылок в документах проверяются через action-linkspector. Орфография проверяется через python-скрипт.

Проверки запускаются при команде Push в рабочую ветку или main или при Pull Request в ветку main. Информация о проверке выводится на странице Pull Request или на вкладке Actions.