Skip to content
This repository has been archived by the owner on Jan 29, 2023. It is now read-only.

Как оформить репозиторий

Vasiliy Vanchuk edited this page Dec 2, 2017 · 1 revision

Все пункты желательно выполнять на английском языке

Чек-лист при оформлении репозитория:

  • Репозиторий имеет внятное и говорящее название
  • У репозитория заполнено поле Description. В нем указано краткое описание проекта
  • На github-pages задеплоена рабочая версия проекта. Ссылка на страницу указана в поле URL в настройках репозитория
  • В репозитории создан файл README.md в корне проекта
    • Файл содержит в себе описание проекта, постановку технической задачи или ссылку на документ с таким описанием
    • Файл содержит блок с описание установки и разворачивания проекта - какие нужны условия, какие выполнять команды
    • Файл содержит описание структуры проекта - назначение файлов и папок, логику разбиения кода
    • Файл содержит скриншоты/видео работы программы
  • Крайне желательно, чтобы при работе использовались ветки и пуллреквесты
  • Текст коммитов должен быть осмысленным и описательным
Clone this wiki locally