Инструкция по оформлению профиля на GitHub

Правильно оформленный профиль на GitHub очень важен для поиска работы: для интервьюера это единственная возможность увидеть ваш код и оценить вас в деле. Мы попросили Георгия Бабаяна, основателя и CEO школы программирования Elbrus Bootcamp, рассказать, как оформить профиль, чтобы показать себя с лучшей стороны.

Георгий Бабаян

CEO Elbrus Coding Bootcamp

GitHub — это лицо программиста. Портфолио демонстрирует как ваши технические навыки, так и soft skills: умение заботиться о пользователе, писать документацию и другие полезные в командной работе навыки. В инструкции я собрал 10 правил и 7 ловушек GitHub, которые нужно знать каждому программисту, который хочет найти хорошую работу.

10 правил оформления профиля на GitHub

Хорошая фотография

Заметная и хорошо читаемая фотография помогает расположить к вам посетителя профиля. Выбирайте снимок с лицом крупным планом и нейтральным фоном.

Имя и фамилия

Обязательно напишите свои имя и фамилию, а не только никнейм, чтобы профиль легко было сопоставить с резюме.

Адрес электронной почты

Убедитесь, что email для связи с вами доступен всем. Для этого зайдите в настройки профиля: там есть специальная кнопка «сделать публичным». Избегайте адресов в духе sexybaby@mail.ru — используйте ящик в доменной зоне.com с понятным неймингом. Не делайте публичным email, который привязан к вашему аккаунту GitHub: это повышает вероятность взлома аккаунта и демонстрирует слабое владение правилами безопасности в интернете.

Биография

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

Ссылка на соцсеть

Добавьте ссылку на профессиональную соцсеть, которую вы ведёте наиболее активно и подробно.

Репозитории

Прикрепляйте только те репозитории, которые вы хотите показать будущему работодателю. Удалите «детские» проекты! Никому не интересно смотреть на «Hello, world!».
Если репозитория ещё нет, сделайте проект сами: создайте чат-бот или простое приложение о погоде — что-то, что поможет увидеть вас в деле.

Забота о читателе

Интервьюеру тяжело: каждый день он смотрит десятки профилей, поэтому опишите каждый проект как можно понятнее. Хороший способ — поставить перед названиями проектов эмодзи, которые помогут сразу понять суть проекта: например, джойстик для игры или вилку с ножом для сервиса бронирования столиков.

README

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

Команда

Если вы делали проект вместе с командой, проявите уважение: добавьте ссылки на репозитории других авторов проекта.

Визуализация

Идеально, если у вас получится прикрепить к проекту гифку или видео, которое показывает, как всё работает.

7 ловушек GitHub — ошибки в оформлении, которые часто делают программисты

Неочевидная команда запуска

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

Мусор в коде

Уберите отовсюду консоль-логи, принты, выводы ошибок и глупые комментарии. Как-то раз я собеседовал на должность преподавателя приятного кандидата и уже собирался предложить ему работу. А затем обнаружил в его коде функцию, которая не делала ничего. Рядом с ней красовался комментарий: «Нужно удалить».

Ошибки в коде

Обязательно прогоните код через линтер: он проверит код на ошибки, укажет на баги и найдёт подозрительные конструкции.

Ключи и пароли в коде

Не оставляйте в ваших репозиториях ключи и пароли — это дурной тон. Храните такие данные в переменных окружения или в .env-файле, добавив его в .gitignore.

Непонятные коммиты

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

Низкая активность

Очень важно постоянно держать зелёным ваш график активности («contributions»). Чтобы не создавалось впечатления, что вы не работаете, создайте специальную папку «Мои решённые алгоритмы». Добавляйте в неё всю релевантную активность: «алгоритм решения судоку», «алгоритм сортировки», чтобы было видно, что вы постоянно что-то делаете.

Плохой стиль

Соблюдайте стайлгайд своего языка — PEP8 для Python, Airbnb Style Guide для JavaScript, Airbnb Ruby Styleguide для Ruby и так далее. Так вы продемонстрируете заботу о комфорте коллег и уважение к принятым в сообществе нормам.