Как оформить GitHub-профиль для первого портфолио: README профиля и закреплённые репозитории

Первое портфолио на GitHub удобно строить на двух уровнях. Профиль объясняет, кто вы и с каких работ начать знакомство. Репозитории показывают сами проекты: задачу, код, запуск и результат. Если оформить только верхний уровень, ссылки могут вести в непонятные папки. Если оставить только код, читателю придётся самостоятельно выяснять, что вы хотели показать.

Ниже — последовательность для личного аккаунта. Примеры проектов и формулировок условные: замените их своим реальным опытом. Красивое оформление не превращает учебную работу в коммерческий проект и не заменяет содержание репозитория.

Создайте специальный репозиторий для README профиля

GitHub показывает README в профиле при выполнении нескольких условий: имя репозитория совпадает с вашим именем пользователя, репозиторий публичный, файл README.md находится в его корне и содержит текст. Это отдельный механизм; файл README в произвольном учебном репозитории автоматически не становится описанием профиля.

1. Откройте создание нового репозитория в своём аккаунте.
2. В качестве имени укажите свой GitHub username. Например, для условного аккаунта your-login нужен репозиторий your-login.
3. Выберите публичную видимость и добавление README.
4. После создания откройте README.md, внесите описание и сохраните изменение.
5. Перейдите в профиль и проверьте результат.

В корне — значит на верхнем уровне репозитория, а не в папке docs или рядом с файлами приложения внутри другой директории. Если подходящий репозиторий уже существует, сначала проверьте его имя, видимость и расположение файла, а не создавайте вторую похожую папку.

Для публичного репозитория с совпадающим именем, созданного до июля 2020 года, документация GitHub описывает дополнительный случай: README может потребоваться вручную показать через Share to profile. Это отличается от обычной проверки пустого или неправильно расположенного файла.

Напишите короткую навигацию по своей работе

Начинающему не обязательно заполнять профиль длинной биографией. В авторском примере ниже есть направление обучения, несколько конкретных навыков и ссылки на работы. Список технологий не должен описывать всё, с чем вы когда-либо сталкивались: выберите то, что можете объяснить по своим проектам.

# Привет, я Анна

Изучаю backend-разработку на Python.
Сейчас работаю с HTTP API, SQL и автоматическими тестами.

## С чего начать
- [Учебный сервис заказов](https://github.com/your-login/order-service)
  — API, проверки входных данных, тесты основных сценариев.
- [Анализ расходов](https://github.com/your-login/expense-report)
  — очистка CSV и небольшой воспроизводимый отчёт.

## Сейчас изучаю
Транзакции и обработку ошибок при работе с базой.

## Связаться
Способ связи указан в доступном разделе профиля.

Это заготовка структуры, а не готовый текст для копирования. Имя, ссылки и описания проектов нужно заменить. Если сервиса заказов у вас нет, не сохраняйте его в списке ради солидного вида. Одну реальную работу можно раскрыть подробнее, чем несколько вымышленных.

Markdown позволяет оформить заголовки, списки и ссылки без отдельной вёрстки. После изменения проверьте отображение: видны ли названия разделов, ведут ли ссылки в нужные места, не остались ли заглушки. Сложные баннеры и счётчики необязательны; в этой схеме важнее понятный маршрут к работе.

Выберите закрепления и задайте им порядок

В профиле можно закрепить до шести репозиториев и gist суммарно. Это верхний предел, а не требование показать шесть проектов. Если готова одна понятная работа, начните с неё. Число четыре или шесть не является критерием качества портфолио.

На своей странице найдите раздел Popular repositories или Pinned и откройте Customize your pins. Выберите доступные для закрепления работы и сохраните выбор. Порядок закреплённых элементов можно менять перетаскиванием. Для первого оформления удобно использовать собственные публичные репозитории.

Перед выбором задайте каждому проекту три вопроса: понятна ли его задача без устного объяснения, видно ли ваше участие и есть ли что посмотреть помимо самого названия. Это авторские критерии отбора, а не правила ранжирования GitHub.

Не обязательно закреплять самые новые репозитории. В предлагаемом порядке сначала показывается наиболее понятная законченная работа, затем — материал, который раскрывает другой навык. Если все карточки ведут к почти одинаковым упражнениям, можно оставить меньше закреплений и пояснить выбор.

Доведите репозиторий до состояния, которое можно изучить

README профиля направляет к проекту, а README проекта отвечает на вопросы о нём. Проверьте этот второй уровень отдельно. Читатель должен понимать, какую задачу решает работа, на каких данных её можно попробовать и как выглядит ожидаемый результат.

Для условного учебного сервиса структура описания может быть такой:

• Задача. Что делает сервис и какую часть реализовали вы.
• Состав. Где находится код, тесты и пример данных.
• Запуск. Предварительные условия и команды именно вашего проекта.
• Проверка. Как воспроизвести один основной сценарий.
• Ограничения. Какие функции пока не сделаны и какие условия пример не обрабатывает.

Не вставляйте универсальные команды запуска, если они не относятся к репозиторию. Например, наличие слова Python в профиле ещё не означает, что в каждом проекте существует файл requirements.txt. Пройдите собственную инструкцию на подготовленном окружении и отметьте, какие условия понадобились. Если полноценную проверку пока не выполняли, не называйте проект проверенным.

Лицензия — отдельное решение. По объяснению GitHub, открытый исходный код предполагает лицензию, разрешающую соответствующее использование, изменение и распространение. Просто публичная видимость репозитория не заменяет такие условия. При этом лицензия не входит в перечисленные условия отображения README профиля. Выбирайте её осознанно для проекта, а не как декоративный пункт списка.

Проверьте профиль как маршрут, а не как анкету

Откройте страницу и попробуйте пройти путь: направление обучения — выбранная работа — описание — воспроизводимый пример. Если на каком-то этапе неясно, куда идти, доработайте именно этот переход. Например, ссылку «Мои проекты» можно заменить названием конкретной работы, а описание «разные задания» — коротким оглавлением.

Если README не появился, вернитесь к условиям специального репозитория: совпадение имени, публичность, файл в корне и непустое содержимое. Если не меняются закрепления, проверьте, сохранили ли выбор в настройке pins и рассматриваете ли собственный профиль. Не пытайтесь компенсировать техническую ошибку дополнительными баннерами в тексте.

При появлении новой работы сначала подготовьте сам репозиторий и его описание. Затем решите, что он добавляет к портфолио: новый навык, более полный проект или замену старому примеру. После этого обновите ссылку в профиле и порядок закреплений. Такой цикл оставляет у читателя актуальную карту ваших работ, а у вас — понятный способ развивать её по мере обучения.