Как новичку оформить профиль на GitHub
Простая инструкция с подборкой нужных сервисов.
Иллюстрация: Оля Ежак для Skillbox Media
Если обычных людей встречают по одёжке, то разработчиков — по их профилю на GitHub. В этой статье мы займёмся его оформлением, подумаем над наполнением и обсудим, нужен ли он вам вообще.
Содержание
Что потребуется для старта
Эта статья предназначена для начинающих разработчиков, которые формируют своё портфолио. Мы не будем углубляться в описание Git и GitHub, предполагая, что базово вы с ними знакомы. Если это не так, советуем перед созданием профиля изучить следующие материалы:
- «Что такое Git: объясняем на схемах». Git — основной инструмент для работы с GitHub, который позволяет отслеживать изменения в коде, создавать ветки разработки, возвращаться к предыдущим версиям и синхронизировать локальные изменения с GitHub-репозиторием.
- «Что такое GitHub и как им пользоваться». GitHub — платформа для хранения проектов и совместной разработки. Здесь вы можете хранить код, участвовать в open-source-проектах и делиться идеями с другими разработчиками. GitHub также служит отличной площадкой для демонстрации вашего опыта перед потенциальными работодателями.
- «Язык разметки Markdown: шпаргалка по синтаксису с примерами». Markdown — это простой язык разметки, который вам понадобится для оформления файла README.md. Этот файл будет отображаться на главной странице вашего профиля на GitHub и служить его визитной карточкой. С помощью Markdown вы сможете форматировать текст, создавать заголовки, списки, добавлять изображения, ссылки и код.
Соберите идеи для профиля
Самая сложная часть создания GitHub-профиля — определить свои цели и желаемый результат. Важно понять, какие элементы вам нравятся, а какие нет, изучить существующие возможности и способы их применения. Если у вас пока нет чёткого видения своего профиля, стоит его продумать.
Самый простой способ собрать идеи — просмотреть профили других разработчиков. В процессе обращайте внимание на следующие аспекты:
- Способы организации сведений о навыках и проектах. Например, одни разработчики группируют технологии по категориям (фронтенд/бэкенд/DevOps), а другие предпочитают сфокусироваться на подробном описании только нескольких ключевых проектов.
- Баланс профессионального и личного контента. Многие разработчики дополняют профиль сведениями о хобби и интересах, чтобы сделать его более живым. Например, можно упомянуть про увлечение фотографией или путешествиями, но основную часть посвятить описанию проектов, технического стека и участию в Open Source.
- Визуальное оформление. Изучите графики статистики, бейджи технологий и иконки, которые улучшают читаемость профиля. Обратите внимание на детали — например, на иконки социальных сетей рядом с контактной информацией или эмодзи. Сохраняйте для себя все понравившиеся элементы.
- Способы демонстрации активности на платформе. Например, графики контрибуций (зелёная сетка), статистика используемых языков программирования или количество звёзд на проектах — всё это позволяет быстро оценить уровень опыта и активность разработчика.
Отберите самые удачные элементы, скомбинируйте их и создайте свой уникальный GitHub-профиль. Например, вы можете позаимствовать минималистичный стиль у одного разработчика, способ презентации проектов — у другого, а оригинальное использование статистики — у третьего. Экспериментируйте, пока не добьётесь желаемого результата.
Вот полезные ресурсы для поиска идей:
- Awesome GitHub Profile Readme;
- Awesome Developer Profile;
- Developer Portfolios;
- Skillbox Media «Код» — скоро мы запустим рубрику, в которой будем собирать для вас подборки вдохновляющих и необычных профилей.
Представьтесь и расскажите о себе в readme-файле
Основой любого GitHub-профиля является файл README. В нём вы можете рассказать о себе, своих проектах и опыте другим пользователям.
Пример оформления:
После создания readme-файла вам не обязательно заполнять его вручную — для этого существуют удобные сервисы. Вы можете выбрать подходящий шаблон, заполнить поля с предложенной информацией и получить готовый код, который достаточно вставить в свой профиль.
Вот некоторые сервисы для генерации readme-файлов:
- GitHub Profile Readme Generator;
- Github Profilinator;
- GitHub Profile Readme Generator;
- ProfileMe.dev;
- GPRM — GitHub Profile ReadMe Maker.
После заполнения readme-файла вы можете дополнить описание о себе изображением. В профиле разработчики обычно размещают своё фото, аватарку, скриншот с фрагментом кода или другой визуальный элемент.
Перед выбором изображения посмотрите на свою страницу глазами рекрутера и подумайте, какое впечатление она произведёт на потенциального работодателя. Не вызовет ли изображение негативной реакции? Если сомневаетесь — просто выберите хорошую фотографию.
Сделайте свой профиль красивым
После заполнения readme-файла ваш профиль полностью готов. Вы можете оставить его как есть или дополнить визуальными элементами. В этом разделе мы рассмотрим примеры таких элементов и поделимся ссылками на популярные сервисы для оформления GitHub-профиля.
Для начала вы можете создать трёхмерный календарь коммитов:
Анимированную заставку:
Вы можете представить закреплённые репозитории в формате мема:
Создать необычный узор из зелёных квадратиков, который будет отображать историю коммитов:
Добавить бейджи:
Всевозможные статистические метрики:
Иконки:
Перейдём к списку сервисов для оформления профиля:
- GitHub Readme Stats — создаёт информативные карточки со статистикой репозиториев. В них можно включить количество звёзд, историю коммитов и диаграмму языков программирования.
- GitHub Readme Streak Stats — отображает вашу текущую серию коммитов и подробную статистику активности.
- GitHub Profile Trophy — превращает ваши достижения на GitHub в коллекцию виртуальных наград.
- Github Readme Activity Graph — графики вашей активности на GitHub.
- Shields.io — красивые значки для различных метрик и технологий.
- Readme Typing SVG — анимированный текст для украшения профиля.
- Badges for GitHub — коллекция готовых значков для визуального оформления ваших социальных сетей и используемых технологий.
- GitHub Contribution Snake — превращает ваш график активности в игру, где анимированная змейка собирает ваши контрибуции на GitHub.
- Metrics — инфографика вашей активности на GitHub.
- GitHub Profile Views Counter — счётчик просмотров вашего профиля.
- GitHub Profile 3D Contrib. — трёхмерная визуализация ваших контрибуций.
🧠 Мудрый совет: излишнее украшательство может отвлечь внимание от ваших навыков и достижений. Поэтому сначала тщательно проработайте readme-файла и только потом переходите к декоративным элементам.
А нужен ли вообще этот профиль?
Среди программистов нет единого мнения по этому вопросу. Просто создать GitHub-профиль недостаточно — он должен быть «живым» документом, в который вы регулярно добавляете новые проекты, обновляете технический стек и актуализируете описание опыта работы. Это требует дополнительных усилий, на которые не всегда есть время.
Если вы готовы уделять время такой работе и планируете использовать GitHub-профиль как портфолио при поиске работы — тогда его определённо стоит создать. При оформлении ориентируйтесь на разработчиков, которые детально описывают свои достижения и проекты.
Например, загляните на красочную страницу Ионы Лоуренса:
Или взгляните на минималистичный стиль Орхуна Пармаксиза. На его странице практически нет графики, но впечатляет список проектов:
Если вы сильно загружены работой и понимаете, что не сможете регулярно обновлять профиль, возможно, не стоит его заводить. Или же ведите его просто для развлечения и рассказывайте о своих интересах.
Например, вы можете опубликовать свой плейлист:
Организовать на странице шахматный турнир или «Сапёра»:
А если совсем нет идей, подойдёт даже белка:
Мы рекомендуем начать с базовой информации, без лишних оформительских элементов. За основу можете взять профили Линуса Торвальдса и Гвидо ван Россума. В будущем, если появится время и желание, вы всегда сможете заняться дизайном и придумать что-то нестандартное.
Больше интересного про код — в нашем телеграм-канале. Подписывайтесь!