Как оформить проект на GitHub

GitHub — витрина программиста. Аккуратно оформленный репозиторий сразу выделяет новичка среди других.

Репозиторий — дом проекта

Репозиторий (repo) — это папка проекта на GitHub с историей изменений. Создайте его, дайте понятное имя (латиницей, без пробелов) и загрузите файлы проекта.

README — лицо проекта

Главный файл — README.md: в нём коротко пишут, что делает проект, как его запустить и пример работы. Именно README видит человек, открывший репозиторий, — поэтому от него зависит первое впечатление.

Порядок в файлах

Держите структуру простой и понятной: код в осмысленно названных файлах, лишнее (черновики, кэш) — не заливать. Файл .gitignore помогает не загружать ненужное.

Совет: один проект — один репозиторий. Так их удобно показывать и обсуждать по отдельности.

Частые вопросы

Обязательно ли знать Git в консоли? Нет, для старта хватит веб-интерфейса GitHub.

Что писать в README, если проект простой? Что делает, как запустить и один пример — этого достаточно.