Профильный README появится, если создать публичный репозиторий с именем, точно совпадающим с вашим username. В README достаточно четырёх частей: кто вы, что делаете, какие проекты стоит открыть и как с вами связаться.
Красивый профиль не означает десятки бейджей и анимированную змейку коммитов. Первый экран должен за 15 секунд ответить на три вопроса: какой у вас стек, что вы умеете собирать и где лежит рабочий код. Всё остальное можно добавить после первого честного каркаса.
Одна строка о роли, стеке и типе задач.
Два или три проекта с результатом, стеком и ссылкой.
Pinned repositories ведут к коду, README и демо без поиска.
Как работает профильный README
Название профильного репозитория чувствительно к регистру и должно совпадать с username. При создании GitHub показывает подсказку о специальном репозитории. Включите Public и Add a README file. Содержимое README.md появится вверху профиля после первого commit.
| Блок | Длина | Что писать |
|---|---|---|
| Заголовок | 1 строка | Имя и роль |
| О себе | 2-3 строки | Стек, интерес и текущая цель |
| Проекты | 2-3 карточки | Задача, стек, демо |
| Контакт | 1-2 ссылки | Почта или соцсеть без личных данных |
После этого шага у каждой части есть одна роль. Интерфейс собирает действие, логика меняет состояние, а вывод показывает признак успеха. Это проще отлаживать, чем один большой обработчик.
Сверху вниз за несколько секунд. Каждый блок отвечает на один вопрос
Пишем короткий README без визуального шума
README пишется на Markdown. Не нужно выравнивать каждый абзац через HTML: обычные заголовки, списки и ссылки лучше читаются в сыром файле и легче обновляются. Замените username, ссылки и описания на свои.
# Привет, я Алексей
Учусь frontend-разработке и собираю небольшие веб-приложения.
Сейчас работаю с JavaScript, TypeScript и CSS.
## Мои проекты
### Weather Card
Поиск погоды по городу через открытое API.
- Стек: HTML, CSS, JavaScript
- [Код](https://github.com/username/weather-card)
- [Демо](https://username.github.io/weather-card/)
### Task Board
Канбан-доска с сохранением задач в localStorage.
- Стек: TypeScript, Vite
- [Код](https://github.com/username/task-board)
## Что изучаю
- доступные интерфейсы
- тестирование JavaScript
- работу с REST API
## Связь
- Email: hello@example.comПервый экран помещает имя, роль и стек. Каждый проект объясняет задачу, а не только называет технологии. Ссылки ведут отдельно к коду и демо. Контакт не раскрывает лишние личные данные.
Содержание важнее декора. Сравнение показывает, какой вариант легче поддерживать и проверять.
Как выбрать и закрепить проекты
Pinned repositories и README решают разные задачи. README даёт маршрут и контекст, а закреплённые репозитории показывают актуальную работу. Выбирайте не самые большие, а самые понятные проекты. У них должны быть README, скриншот, способ запуска и осмысленная история commit.
| Проект | Стоит закрепить | Почему |
|---|---|---|
| Калькулятор из урока | Скорее нет | Не показывает ваше решение |
| Маленькое готовое приложение | Да | Есть задача и демо |
| Командный проект | Да, с описанием роли | Показывает Git-практику |
| Заброшенный черновик | Нет | Битая сборка и нет итога |
Сохраняйте в одном месте то, что может измениться. Если одно и то же значение скопировано в три функции, после первой правки они начнут расходиться. Один объект состояния и одна функция отрисовки снимают эту проблему.
Практика: проверяем профиль глазами гостя
Откройте профиль в приватном окне браузера. Так вы увидите его глазами гостя и не спрячете ошибку за правами владельца. Перейдите по каждой ссылке, проверьте мобильную ширину и убедитесь, что в первых двух экранах нет моря декораций.
- Создайте публичный репозиторий с именем username.
- Замените текст примера на свою роль, стек и цель.
- Добавьте два реальных проекта с рабочими ссылками.
- Закрепите эти репозитории в Customize your pins.
- Откройте профиль без авторизации и пройдите все ссылки.
- Удалите бейдж, если он не даёт новой информации.
README виден на главной странице профиля. За 15 секунд понятны роль, стек и два лучших проекта. Все публичные ссылки открываются без входа. На мобильном экране нет горизонтальной прокрутки.
Откройте его без авторизации. Пройдите все четыре сценария перед публикацией проекта.
Доводим GitHub-профиль до чистого вида
Одна живая карточка проекта полезнее пяти статических бейджей. Если демо не развёрнуто, дайте команду запуска и скриншот. Не пишите себе статус Senior или эксперт, если проекты этого не показывают. Честное «учусь и собираю» с двумя законченными проектами звучит сильнее.
README останется обычным файлом и не появится в профиле.
Они оттесняют проекты ниже первого экрана.
Проверяйте профиль без авторизации.
Карточке нужны описание, язык, README и понятная история commit.
Что получится в итоге
Готовый профиль не перегружен: сначала имя и стек, затем два проекта с кодом и демо.
Как назвать репозиторий?
Точно так же, как username в GitHub, с тем же регистром.
Сколько проектов показать в README?
Два или три самых понятных, с коротким описанием, стеком и ссылками.
Нужны ли бейджи?
Только если они дают новую полезную информацию и не вытесняют проекты.
Как понять, что проект готов?
Он повторяет целевой сценарий несколько раз подряд, понятно реагирует на ошибочный ввод и не теряет состояние при обычных действиях.
Можно ли копировать код целиком?
Можно как стартовую точку, но сначала замените значения из примера, затем запустите проект по шагам. Если вы не можете объяснить одну строку, её лучше разобрать до следующего шага.
Коммиты, ветки и README можно закрепить в курсе Git. Если проект ещё на компьютере, используйте гайд по загрузке на GitHub.
Демо статического сайта можно открыть через публикацию на GitHub Pages. Перед этим проверьте базовый цикл commit, push и pull.