Оформление профиля на GitHub — Трудоустройство для разработчиков
Многие начинающие специалисты не могут найти работу. Часто это связано с тем, что у них нет опыта или его нечем подкрепить. Если у опытного программиста спросят, чем он занимался на предыдущей работе, то он сможет об этом рассказать. Но тем, кто только начинает путь в IT, показать будет нечего.
В последнем случае опыт нужно нарабатывать. Это можно сделать уже во время обучения, а также принимать участие в Open Source. А продемонстрировать практику поможет GitHub.
В этом уроке разберемся, зачем разработчику вести GitHub, как оформлять профиль и вести активность. Еще узнаем, чем заполнять репозиторий, если нет опыта и собственных проектов.
Что такое GitHub и как он помогает
GitHub.com — это веб-сервис, где можно хранить Git-репозитории. Еще там размещают код большинства Open Source проектов. В них может поучаствовать любой желающий разработчик.
GitHub — это еще и социальная сеть для программистов. Здесь у каждого пользователя есть публичный профиль, который помогает в поиске работы.
Чтобы показать свой опыт потенциальному работодателю, нужно оставить в резюме ссылку на профиль. Когда рекрутер или другой специалист перейдут по ней, то увидят информацию о вас.
Код — лучшее доказательство вашей подготовки. В современном мире доходит до того, что некоторые работодатели ищут сотрудников через анализ кода на гитхабе.
В профиле важны следующие составляющие:
- Основная информация о специалисте
- Активность в публичных проектах
- Репозитории
Разберем каждую из них подробнее. Так вы поймете, чем заполнять профиль, и что привлекает работодателей.
Как оформить основную информацию о специалисте
Основная информация профиля — это первое, что видят рекрутеры. Поэтому ее важно оформить так, чтобы она не выглядела пустой. Вот что должно быть в хорошем профиле:
- Личная фотография. Профиль в GitHub — это не документ, здесь не обязательно ставить серьезную фотографию как на паспорт. Загрузите такое фото, которое будет располагать к себе
- Имя и фамилия. Если вы планируете работать в команде и официально трудоустраиваться, то напишите настоящие имя и фамилию. Так рекрутеры будут знать, что это действительно ваш профиль
- Репозитории. Они нужны, чтобы продемонстрировать опыт работы. Это одна из самых важных составляющих профиля. О репозиториях подробнее поговорим немного позже
Еще в профиле можно указать компанию, в которой работаете, ваше месторасположение, ссылку на личный сайт и на аккаунт в Twitter. Также можете написать краткую биографию.
Если хотите рассказать о себе больше, то это можно сделать в специальном репозитории, в котором размещается текстовый файл README.md.
Как оформлять README
README.md оформляется с помощью языка разметки Markdown и отображается на странице профиля.
Репозиторий, в котором размещается текстовый файл, должен называться так же, как и ник на GitHub: https://github.com// . Например, если ваш ник Alexxx, то репозиторий должен называться https://github.com/Alexxx/Alexxx .
В этом файле может быть любая информация, которая будет полезна другим. Это можно сравнить с резюме, в котором стоит указать следующую информацию:
- Образование. Укажите наличие высшего образования, даже неоконченного
- Дополнительное образование. Укажите курсы, участие в хакатонах, воркшопах и других похожих мероприятиях. Можете рассказать о книгах, которые читали. На Хекслете составлен список рекомендованных книг, важных для любых разработчиков
- Опыт работы. Указывайте любой опыт, который хотя бы косвенно связан с разработкой. Опыт стоит указывать через достижения — чего удалось добиться на предыдущих проектах. Например, вы автоматизировали какие-то задачи на прошлом рабочем месте, или даже создали сайт для компании
- О себе. Расскажите немного о себе, чтобы найти точки соприкосновения с работодателем. Сюда можно добавить информацию, которая не вошла ни в один из блоков, но вам важно об этом сказать. Например, можно рассказать о том, какие новые языки программирования вы изучаете, за какими ресурсами следите, какая методика построения рабочих процессов вам ближе
- Ключевые навыки. Не указывайте слова, про которые вы слышали и примерно представляете, но никогда не работали с ними. Если вы пробовали разные языки, то так и напишите «написал пару скриптов на python». Четко разделяйте хорошо знакомые вам вещи, и те, с которыми вы знакомы только поверхностно. Разделяйте навыки на фундаментальные и прикладные К фундаментальным относятся:
- Знание операционных систем, владение Linux
- Знание сетей, tcp/ip, http
- Алгоритмы и структуры данных
- Математическая подготовка
- Базы данных. SQL
- Владение автоматическим тестированием. Если у вас есть этот пункт, то вы уже лучше, чем 99% новичков и многих работающих программистов
- Языки и уровень их владения
- Фреймворки. Особенно актуально для веб-разработки
- Ключевые библиотеки. Этот пункт довольно опасен. Новички пытаются указать все, что они видели в глаза. Но так делать не надо, это подчеркивает ваш уровень. Указывайте только то, что может быть важно работодателям. Например, react или jquery
В среде разработчиков популярны сервисы вопросов-ответов такие как Stackoverflow или Хабр Q&A . Даже если вы только начинаете свой путь, всегда есть люди, которые знают меньше вас. Зарегистрируйтесь на этих сервисах и начните отслеживать вопросы от новичков. Даже десяток полезных ответов даст вам много плюсов в карму. Работодатели ценят такую активность.
О чем не стоит писать:
- Не указывайте форматы данных, например, json или xml. Форматы никак не характеризуют вас, но создают ненужный шум
- Не добавляйте похожие вещи, например, css2 и css3. Если вы знаете css, то укажите что-то одно
- Не указывайте базовые навыки по работе с компьютером, например, опыт работы с офисными документами. Профессиональное владение компьютером и так подразумевается
Кроме перечисленных блоков, укажите в этом файле ссылки на другие социальные сети и статус занятости. Так работодатель сможет лучше изучить вас и поймет, свободны ли вы сейчас как специалист.
Профиль желательно оформлять на английском языке. Его можно назвать стандартом общения в IT, даже если вы не планируете выходить на международный рынок. Если знаете язык недостаточно хорошо, попросите знакомых перевести текст.
Многие рекрутеры и работодатели только по основной информации о кандидате принимают решение, брать ли его на работу. Поэтому этой составляющей профиля не стоит пренебрегать.
Еще часто обращают внимание на активность программиста. Этот показатель отражает, насколько человек вовлечен в работу, сколько он уделяет этому времени, какие направления ему интересны, где он силен и пробует себя.
Как вести активность в публичных проектах
Любая публичная активность на GitHub отмечается в профиле. Например, коммиты в свои или чужие репозитории, пулл-реквесты. Публичная активность отображается всем, поэтому рекрутеры, работодатели и другие разработчики видят, где вы принимали участие и что делали.
Часто Open Source проектами оказываются те, которыми мы пользуемся. Например, у Хекслета есть несколько Open Source проектов, в которых студенты принимают активное участие. Большинство из них — проекты, которые работают в продакшене. Вокруг них собираются пользователи и люди, которые их разрабатывают. Участвуя в таких проектах, можно получить реальный продакшн-опыт.
Помимо проектов Хекслета есть и другие. Например, можно принять участие в разработке фреймворка или библиотеки. Такую активность обязательно оценят, и опытные разработчики это подтверждают. Подробнее работу с Open Source проектами разберем в следующем уроке.
Публичная активность — это отличный способ заявить о себе. В первую очередь рекрутеры обращают внимание на те проекты, которые вы разрабатываете сами. Они отображаются в репозитории.
Как оформить репозиторий
Репозиторий содержит все файлы проекта и историю их изменений. Он отражает опыт разработчика. Но его нужно хорошо оформить.
Рекомендуемые пункты по оформлению репозитория:
- Есть краткое описание проекта
- Есть README проекта
- Код проекта соответствует общепринятым стандартам, используется GitHub Actions и написаны тесты
- Проект работает и выполняет свою задачу
- Git используется по назначению
Разберем эти пункты подробнее.
Описание проекта
Краткое описание проекта отображается на главной странице, если репозиторий прикреплен в профиле. Так специалист, который изучает ваши работы, сможет выбрать нужный ему проект и не заходить в каждый.
README проекта
GitHub по умолчанию отображает файл README.md на странице репозитория. В нем можно указать следующую информацию о проекте:
- Название проекта и его описание
- Команды установки, локального запуска, запуска тестов и линтеров
- Примеры использования — например, ссылка на страницу с веб-демонстрацией, примеры использования в коде или скриншоты
- Информация о том, можно ли поучаствовать в этом проекте, как связаться, ответы на частые вопросы
README.md — это краткая документация. Это первое, что видит человек, который открывает репозиторий. Поэтому здесь важно дать достаточно информации о проекте и рассказать, что он из себя представляет.
Соблюдение стандартов кода и GitHub Actions
Если репозиторий содержит код, то его нужно оформить по современным общепринятым стандартам, он должен соответствовать правилам линтера. Желательно, чтобы в проекте использовалась система сборки Continious Integration, например, от самого GitHub — GitHub Actions. Такая система позволяет узнавать о том, собирается ли проект, соблюдаются ли правила кодирования, проходят ли тесты. Знания Continious Integration приветствуются во многих компаниях.
Использование Git
Еще специалисты обращают внимание на то, как пишут коммиты. Так оценивают уровень владения Git. Например, некоторые разработчики не используют Git и загружают свои проекты через форму. Это может оказать негативное впечатление. Рекомендуем пройти курс «Введение в Git» и использовать его хотя бы на базовом уровне.
Если оформить репозиторий по этим правилам, то у рекрутеров вряд ли останутся вопросы по вашим навыкам. Однако программисты без опыта могут столкнуться с проблемой — им нечего показывать. Но это легко исправить. Рассказываем, чем новичкам наполнять репозитории.
Где новичкам взять проекты
Любой программист может разработать свой проект. Их можно придумывать или брать за идею сторонние. Главная цель проектов новичков — показать потенциальным работодателям, что вы умеете разрабатывать.
Например, если вы студент Хекслета, то можете выполнять наши проекты. Каждый учебный проект — это самостоятельное приложение, которое вы разрабатываете. Помимо учебных проектов можно выполнять тестовые задания из различных компаний.
Вот пара полезных ссылок:
- В книгах по программированию часто содержатся задания в конце глав. Создайте под книгу отдельный репозиторий и выкладывайте там код. Для СИКП у нас есть целая инструкция
- На Хекслете собрана большая подборка тестовых заданий на разные позиции от множества компаний. Найдите то, что вам по душе и реализуйте
Также можно участвовать в Open Source проектах, работу с которыми мы подробнее разберем в следующем уроке.
Когда у вас появятся более сложные проекты на GitHub, вы можете ими заменить в профиле те, которые не отражают ваш релевантный опыт или более простые.
Можно принимать участие не только в чужих проектах, но и в своих. Например, пет-проект или личная библиотека могут найти отклик у коммьюнити программистов и стать популярными.
Еще можно заводить репозиторий с мелкими алгоритмическими задачами или упражнениями из книг.
Репозитории — способ показать ваш опыт и навыки. Так вы можете доказать, что не только принимаете активное участие в публичных проектах, но и создаете свои.
Вывод
Профиль в GitHub — это обязательный атрибут современного разработчика. Благодаря GitHub можно найти работу, продемонстрировать свои навыки и поучаствовать в интересных проектах на новых технологиях.
В профиле должна быть релевантная и полезная информация: личные данные, активность в публичных проектах и свои проекты. Если на профиль зашел рекрутер, он сможет оценить ваш опыт и профессионализм и написать.
Не забывайте, что репозитории нужно оформлять качественно — с описанием того, что за проекты и как их запустить. Это повышает привлекательность и интерес к проекту со стороны.
Когда вы наберетесь опыта, GitHub станет еще полезнее. Например, вы сможете перейти на пассивный поиск работы. Когда будут спрашивать про ваш опыт, достаточно дать ссылку на профиль. В нем будет вся необходимая информация об используемых технологиях и примеры проектов.
Еще благодаря Open Source опытные программисты работают с технологиями, которые не используются в рабочих проектах. Так они повышают свои навыки. Также они сами создают свои проекты, которые потом становятся популярными.
Также рекомендуем воспользоваться бесплатным помощником для создания красивых GitHub-профилей ProfileMe . В нем можно выбрать один из более 60 языков программирования и фреймворков. Еще с его помощью можно дать ссылки на профили в социальных сетях и делиться статистикой.
Дополнительные материалы
- Как разработчику улучшить свое тестовое задание — рекомендации по оформлению репозитория
- Примеры оформления профилей на Github
- Слаконар: ревью профилей в Github
- Интервью с техническим директором Авито (вторая часть про найм)
- Публичное собеседование
- ProfileMe: помощник для создания GitHub-профилей
Остались вопросы? Задайте их в разделе «Обсуждение»
Вам ответят команда поддержки Хекслета или другие студенты
Как оформить профиль на GitHub так, чтобы он работал при поиске работы
Эта статья о том, как начинающим разработчикам оформить профиль на GitHub так, чтобы он стал дополнительным преимуществом на собеседовании. Статья будет полезна в первую очередь новичкам, ведь им сложнее других найти работу. Опытные специалисты тоже, надеюсь, найдут в этом материале для себя ценные соображения и практики.
Я уже более 15 лет управляю процессами создания продуктов — от гипотез до устойчивых продаж. Последние два года вместе с fellow kottans помогаю новичкам и свитчерам приобретать новые технические скиллы в разработке, развивать soft skills и находить первую работу в IT. Часто вижу у людей проблемы с презентацией своих навыков и личных проектов, в частности профиля и репозиториев на GitHub, поэтому и решил написать этот материал.
Сразу договоримся о контексте: речь будет идти о настройке профиля на GitHub для поиска работы.
Нужно ли это
Чаще всего от кандидата на позицию разработчика ожидают определённого уровня технических знаний. Новичкам особенно тяжело: практики мало, опыта прохождения технических интервью тоже не хватает или совсем нет. А ещё прескрининг. Код кандидата, написанный до интервью, может стать конкурентным преимуществом. Тестовые задания дают не только для того, чтобы проверить умение писать алгоритмы и оперировать структурами данных, но и чтобы увидеть подходы к решению задачи, структуру проекта и код. Любой код, доступный на этапе прескрининга, может стать предметом изучения интервьюеров ещё до первой встречи. И кто знает, возможно, вам дадут меньше тестовых заданий или вовсе обойдутся без них. А тесты — это же всегда стресс, сказывающийся на качестве работы.
Вряд ли есть место для хранения кода лучше, чем GitHub. И даже небольшое портфолио аккуратного и выразительного кода может оказаться главным козырем кандидата в борьбе с конкурентами за вакансию.
Существуют различные взгляды на открытые портфолио проектов на облачных VCS (GitHub, GitLab и подобных). Многие опытные разработчики считают, что на профиль никто не смотрит (см. Простое решение). Для некоторых тим- и техлидов увидеть code style и способ организации кода в проекте (особенно в отношении кандидата-джуна) лучше, чем услышать 1000 слов на собеседовании. Правильное оформление профиля и двух-трёх наиболее показательных репозиториев на GitHub поможет обойти конкурентов. А когда по итогам цикла собеседований остаётся несколько равноценных кандидатов, то каждый бит информации может оказаться решающим — в том числе и проекты на GitHub.
Во всяком случае, если уж и указывать линк на GitHub-профиль в резюме, то точно есть смысл помочь ревьюеру увидеть самое главное.
Конечно, первое, что увидит ревьюер, — титульная страница профиля, с которой его нужно провести на конкретный проект или проекты. Тут все должно быть информативно и удобно.
Если профиль пустой, возникает закономерный вопрос: зачем в резюме добавлена ссылка на GitHub-профиль и почему в списке проектов — пусто? Ответ «Ну, если надо, то добавлю» — плохой.
Начнём с проектов.
Что показать, если показать нечего
Никто (sic!) не ожидает увидеть уникальный проект на 100500 строк кода. Оценивать, скорее всего, будут уровень владения шаблонами проектирования, стиль кода, способность написать минимальную документацию, навыки работы с Git. Почему это всё важно? Потому что это о коммуникации. Это то, чего будут ожидать от сотрудника, помимо написания собственно кода. Код пишется в первую очередь для других людей.
Разумеется, могут оценить и уровень владения технологиями. Одно дело — прочитать в резюме «CSS3 — средний» или услышать ответ на вопрос «А что ты умеешь в JavaScript?». И совершенно другое — увидеть в репозитории хорошо читаемый код, отражающий действительные технические навыки.
Оговорка для педантов: ясно, что обмануть можно и там, и там. Но в этой статье речь не об этом классе проблем.
Выберите два-три проекта, которые наилучшим образом отражают ваши навыки. Учебные тоже годятся (быстро допили незаконченные). Или добавьте одну-две простых игры типа крестики-нолики, Frogger или Memory Game. Все новички делают что-нибудь такое, но не все завершают и показывают. Не ищите оригинальности — это всё ради демонстрации навыков и умений. Демо не обязательно должны быть сложными, с анимациями, встроенным видео и миллионом визуальных эффектов. Достаточно одной фишки.
Вот отличный пример работы студентки курса по фронтенду, а теперь разработчицы в MacPaw Mary Fedirko — погодное радио (нажми кнопку ON). В этом проекте она продемонстрировала творческий подход не только к написанию «очередного JS-фреймворка», но и к дизайну и внешнему представлению в целом. Нестандартный вид учебного проекта — это и дополнительная мотивация в процессе выполнения (делать подобные интерфейсы в разы интереснее), и повышение вероятности того, что на такой проект работодатель обратит внимание.
Было бы здорово, если бы кто-то сделал ревью вашего кода.
Некоторые разработчики советуют раскрывать в резюме участие в проектах с открытым кодом. А для этого нужно поучаствовать в таких проектах 🙂 На самом деле это не очень сложно и даже можно найти материалы и поддержку в этом процессе.
Ещё один источник проектов — хакатоны. Онлайн, оффлайн, локальные/международные — выбирайте на свой вкус. Их ежемесячно проводятся десятки. Кроме того, указание хакатонов и митапов в резюме — ясный индикатор заинтересованности в профессии.
Еще один совет: лучше учебные репы, чем ноль реп. При прочих равных условиях кандидат с даже «примитивными» проектами выигрывает у кандидата с отсутствующими общедоступными следами деятельности. Репозитории можно удалять, архивировать и сделать приватными — так профиль со временем будет становиться всё более профессиональным.
Оформляем репозиторий
Цель оформления репозитория — показать товар «лицом». В этом контексте проигрывают те, кто оформляет проект в стиле «сами разберитесь, как моё приложение запустить, чтобы увидеть, как оно работает». Потому что это всё может быть очевидно для автора, но не для стороннего наблюдателя.
В профиле пользователя есть возможность запинить до 6 проектов. Выберите (или создайте) те, которые лучше всего демонстрируют ваши навыки, и приступайте к их оформлению. Это несложно.
Краткое описание и ссылка на публикацию
В самом верху страницы проекта есть место для краткого описания и ссылки на работающую задеплоенную версию. Для фронтенда со ссылкой проще, конечно. Если ваш проект можно опубликовать — сделайте это, хотя бы на GitHub pages. Даже автоматически сгенерированная страница из документации — уже что-то. Во-первых, хоть как-то индексируется гуглом, а во-вторых, позволяет выработать привычку оформлять проект полностью.
Начать просто — нажмите кнопку Edit.
В вебе выглядит так:
Источник: kottans stats by Igor Kurkov
Из Description, кстати, формируется содержание тега страницы проекта, if you know what I mean.
Документация
Чаще всего README . md содержит одну только строку: # project-name.
Что должно быть в README . md:
- О чём проект? Например: «A movies database web application», «Rick and Morty universe REST server».
- Зачем этот проект? Например: «I mastered CSS animations, CSS Grid, CSS Flexbox» (пункты, разумеется, оформить отдельными буллет-поинтами).
- Ссылка на демо (да-да, ещё раз повторить то, что уже есть в описании — overcommunication не грех).
- Инструкции по сборке и запуску проекта. Это вот всё git clone … , yarn build … и прочее — как во взрослых проектах.
- Структура проекта, архитектура приложения, API — это тоже показывает навыки, необходимые разработчику.
Пишите всё это в синтаксисе markdown. Так мы демонстрируем владение ещё одним полезным навыком.
Цель этого не только дать читателю хорошее представление о проекте, но ещё показать отношение к документированию (не любить писать документацию можно будет потом) и базовые навыки подготовки документации. Смотрите, например, учебный проект с использованием The Movie Database API.
Источник: Movie Database by Vlad Vorobiov
Кстати, сделать из такой документации сайт может быть актуально для не-фронтенд-проектов — документация без лишних элементов интерфейса GitHub читается лучше. Это довольно просто: нужно в настройках включить публикацию.
GitHub даже подскажет, по какому адресу теперь можно обнаружить опубликованный сайт. Перенесите эту информацию в описание проекта.
Вот так README.md может выглядеть, когда опубликован:
Источник: Git course. Проект на GitHub
Продвинутые техники
Скриншоты, скринкасты
Если у приложения есть человеческий интерфейс, скриншоты в документации добавят очков.
А скринкаст в виде гифки сделает демо ещё более наглядным. Пример: описание задачи в курсе по фронтенду. Гифку лучше захостить за пределами GitHub, допустим, на imgur.
Чем сделать такую гифку? Например, oCam for Windows. Можно записать скринкаст с помощью QuickTime для Mac или встроенными средствами Windows 10 (Win+G) и затем сконвертировать с помощью MOV to GIF или MP4 to GIF.
Для записи работы в терминале хорошо подходит asciinema.
Topics
На будущее: topics помогают проекту появиться в поисковых запросах. Какие ключевые слова вписывать? Начните с используемых в проекте технологий: JavaScript, ReactJS, Python, Java, C#, Laravel, PHP, REST, MongoDB, Node, PostgreSQL, SPA, web app, AMP, CSS, HTML. Добавьте два-три ключевых слова о самом проекте: game, casual game, database, movies, weather, demo, educational, tutorial. GitHub ещё что-нибудь подскажет из своего списка.
Источник: React patterns, demo by Vitalii Ovcharenko
Теперь проект можно найти по любой из тем. Ну и помним: чем больше будет звёзд у проекта, тем выше он окажется в поисковой выдаче.
Промежуточный summary
На хорошо оформленный репозиторий можно дать прямую ссылку в резюме. Указывайте ее прямо в разделе Skills или Education — где релевантно. Это должна быть ссылка не такого вида github.com/username/repo, а аккуратная и лаконичная, хоть и выглядящая немного «по-инженерному», например: react-patterns project. Тут реальный путь скрыт за описанием проекта. Щёлкать по линкам уж все умеют, а читабельность заметно лучше.
Оформляем профиль
Титульная страница профиля на GitHub позволяет быстро оценить активность пользователя. Для ее оформления также можно использовать альтернативную визуализацию (на примере профиля Bohdan Kovalchuk) — прямо берите и вставляйте в резюме чарты.
Но давайте сравним два профиля на GitHub.
Источник: профиль на Github by Aleksey Ivanov
Чем отличается второй:
- не рандомная аватарка;
- есть имя (если профиль — ваше резюме, то чего стесняться?);
- статус явно говорит о том, что Алексей открыт к предложениям о работе;
- коротко описаны скиллы (Front-end, React, NodeJS);
- есть ссылка на профиль в LinkedIn;
- есть 6 отобранных проектов, с которых заинтересованный посетитель и начнёт изучение портфолио.
Зайдите в свой профиль сейчас, нажмите Customize your pins и добавьте хотя бы самых показательных проекты. Затем в настройках профиля заполните всё, что возможно.
Делаем личное портфолио на GitHub
Знаете ли вы, что проект вида username.github.io после публикации доступен, собственно, под таким именем? Вот пример личного сайта-портфолио (проект на гитхабе, Ruslan Sakevych):
Код
По логике, этот раздел должен быть выше. Но это, пожалуй, самая сложная часть для новичков, поэтому оставил её напоследок.
Стиль кода
Мы уже говорили, что код пишется для других людей? Ещё раз повторим: код пишется для других людей. Это значит, что код должен быть читаемым. Соблюдение стиля кода, принятого в вашем технологическом стеке, адекватный нейминг переменных, классов, функций, модулей и файлов — это всё важно в работе. Если человек этому не следует даже в самых маленьких своих проектах, где он царь и бог, вряд ли можно ожидать, что он будет это хорошо делать в других. Вероятность есть, конечно, но по опыту — очень низкая.
Так что «причешите» код, который планируете показывать. Линтеры вам в помощь (заодно научитесь настраивать, если ещё не умеете). Можно, не стесняясь, брать преднастроенные проекты — Open Source. Например, ESLInt-Prettier-Husky boilerplate для JS фронтенда или EodData CLient (Python, Aleksey Ivanov). Для вашего стека придётся поискать или поспрашивать кого-нибудь.
Коммиты
Комментарии коммитов тоже пишутся для других людей. Комментарии вида «added file», «fixed», «add code» и подобные (осторожно, вредные советы!) говорят о недостаточно хорошо развитых навыках изложения мысли и нелюбви к людям, которые будут читать ваш код. Самое время приобретать правильный навык. И лучше немного помучаться над текстами коммитов в учебных или пет-проектах, чем потом выслушивать от старших по званию коллег ворчливые замечания или вообще не найти желающих сделать код ревью.
Вот один из примеров читабельной истории коммитов: frontend project lvl1 by Sergey Shramko.
Простое решение
Чтобы не заниматься всем вышенаписанным, можно просто никому никогда не признаваться в наличии профиля на GitHub. Нет материала — нечего критиковать.
Итого
GitHub-профиль работает и помогает — когда он есть. Оформить его аккуратно — означает позаботиться о тех, кто будет его изучать в процессе прескрининга и собеседований, и, следовательно, о себе как о конкурентоспособном кандидате.
Свидетельства «очевидцев» из числа моих знакомых разработчиков-новичков:
Евгений, Front-end Developer: «У меня спрашивали про самый интересный проект: что делает, почему так, логику и связи модулей. Ещё открывали другой проект и по нему тоже задавали вопросы. Я уже пару месяцев как трудоустроился. По моему мнению, что сработало: 1. Множество тестовых задач с других собесов, часть из которых опубликовал на гитхабе; 2. Собственные нетипичные и работающие микропроекты».
Лена, Front-end Developer: «Задавали вопросы по моим проектам на нескольких собеседованиях. Смотрели портфолио. На одном просили прокомментировать самый интересный проект из примеров на гитхабе».
А у вас когда-нибудь смотрели портфолио? Помогало ли портфолио при поиске работы?
Что ещё почитать по связанным темам
- Что портит резюме разработчика
- Резюме ІТ-спеціаліста: розбір типових помилок з точки зору HR
- Что писать в резюме, если нет опыта работы
- Что написать в резюме, если нет опыта работы
- Что написать в резюме junior программисту без опыта работы? — Блог Виктора Зинченко
- Идеальное резюме Junior’а: как найти лучшую работу в сфере информационных технологий
- 3 tools to visualize your GitHub profile
- Инструменты для построения онлайн резюме
- DataArt запустил бесплатный сервис улучшения резюме CV Duck
- A Guide to Creating and Hosting a Personal Website on GitHub
Credits
Спасибо команде kottans и персонально Christina Landvytovych, Oleksandr Lapshyn за поддержку и contribution в материалы статьи.
В качестве иллюстраций здесь используются проекты разработчиков, которые так или иначе имеют отношение к комьюнити kottans. Если вам какой-то из проектов понравится, не пожалейте поставить ⭐ на GitHub — вам обязательно воздастся 🙂
Все про українське ІТ в телеграмі — підписуйтеся на канал DOU
�� Подобається Сподобалось 7
До обраного В обраному 43
Как оформить профиль на GitHub с помощью GitHub Profile Readme
Время идет, а вопрос не перестает быть актуальным. В сферу информационных технологий приходят все новые и новые люди, которые задаются вопросом оформления своего личного профиля на гитхаб.
В данной статье вы узнаете:
- Что такое GitHub Profile Reedme.
- Почему стоит использовать Readme профиля.
- Как создать GitHub Profile Readme.
- Как оформить личный профиль на GitHub.
Что такое GitHub Profile Readme
Как вы наверняка знаете, файл README.md на GitHub — это текстовый файл, поддерживающий Markdown, который содержит основную информацию о проекте. Он знакомит с тем, что это за проект, и объясняет основные моменты, связанные с ним.
README профиля на GitHub — это тот же самый README, вот только отображается он не в репозитории проекта, а в профиле, и информацию он содержит не о проекте, а о конкретном человеке — владельце этого профиля.
Почему стоит использовать Readme профиля На самом деле, на гитхабе существует раздел bio, в который мы также можем добавить информацию о себе, вот только он не поддерживает Markdown. Соответственно, добавление ссылок, картинок, заголовков, бэйджей и т.д. становится невозможным. Собственно, именно поэтому и стоит использовать README файл для оформления профиля.
Как создать GitHub Profile Readme
Файл README находится в GitHub репозитории, название которого совпадает с именем пользователя учетной записи GitHub. Соответственно, для того чтобы создать такой репозиторий, необходимо:
1. Зайти на GitHub под своей учетной записью.
2. В правой верхней части экрана раскрыть выпадающее меню и нажать New repository.
3. Ввести название репозитория, которое совпадает с именем пользователя на GitHub.
4. Добавить описание данного репозитория (по желанию).
5. Оставить репозиторий Public, так как он должен быть публичным.
6. Поставить галочку напротив пункта Add a README file.
7. Нажать кнопку Create reposotiry.
После этого шага необходимый репозиторий будет создан.
Как оформить личный профиль на GitHub
README файл вашего профиля это то место, где вы можете дать разгуляться вашей фантазии. В большинстве случаев используются следующие разделы:
- Кто вы и что из себя представляете.
- Над чем работаете в данный момент.
- Что изучаете.
- Какими знаниями обладаете.
- С чем вы можете помочь, и какая помощь требуется вам.
- Ваши социальные сети / контактные данные.
И то, как будут выглядеть эти разделы, ограничивается только воображением.
Для оформления профиля требуется хотя бы по минимуму понимать, что есть Markdown (язык разметки), и иметь представление о его базовых возможностях.
Добавление изображений и гифок
Для того чтобы профиль был максимально красивым, необходимо как можно больше красивых и красочных компонентов, поэтому не обойтись без различных картинок. Для их добавления можно использовать следующий синтаксис:
В кавычках src=»» указывается ссылка на желаемую вами картинку. В данном примере картинка загружена в репозиторий на GitHub. В width=»» указывается ширина картинки. Аналогично можно использовать атрибут heigth=»», который используется для обозначения высоты.
Если есть необходимость сделать изображение кликабельным, подойдет следующий синтаксис:
В данном случае, тэг
оборачивается тэгом — ссылкой.
В href=»» между кавычек вставляем ссылку, по которой будет осуществляться переход при нажатии на картинку.
target=»_blank» откроет ссылку в новой вкладке.
Также картинку можно добавить следующим способом:
[](https://www.shpavda.com/)Использование иконок
С добавлением изображений все понятно, но при добавлении различных инструментов, которые вы используете: языков, фреймворков и т.д., — стоит использовать уже готовые иконки вместо того, чтобы «изобретать колесо» в фотошопе.
Сервисы, которые предоставят вам такие иконки:
Simple Icons — на момент написания данной статьи имеется более 2 000 иконок популярных брендов.
Icons8 — имеет большое количество иконок, иллюстраций и фотографий. Использование некоторых возможностей не бесплатно.
Flaticon — огромное количество векторных картинок и целых коллекций этих картинок. За многие также придется заплатить денюжку.
Добавление бейджей
Добавление бейджей в файлы README тоже довольно распространено не только в файлах профиля, но и в файлах различных проектов. Для создания бейджей можно использовать Shields.io.
В целом, для добавления бейджа используется следующий синтаксис:
https://img.shields.io/badge/--
Вместо , , добавляются соответствующие значения. После чего получается стандартный бейдж. Для создания также доступны бейджи и других стилей. Для этого в конце вышеприведенной записи необходимо добавить один из следующих сегментов в зависимости от необходимого стиля:
Также можно добавлять и различные логотипы, как показана в примере ниже.
Вот так могут выглядеть бейджи, сделанные на shields.io:
### Languages and Tools:        ### Socials: [](https://t.me/the_cybermania) [](https://www.youtube.com/alexeyshpavdaMain) [](https://www.instagram.com/alexeyshpavda) [](https://twitter.com/alexeyshpavda) [](https://www.linkedin.com/in/alexeyshpavda) [](https://vk.com/alexeyshpavda) [](https://www.facebook.com/alexeyshpavda)Примечание: как вы видите, в вышеприведенном примере в конструкции https://img.shields.io/badge/— отсутствует лейбл, то есть запись принимает следующий вид https://img.shields.io/badge/— . Как следствие, в итоговом варианте у бейджа отсутствует левая часть.
Для полного ознакомления с тем, как использовать Shield.io, рекомендуется перейти по ссылке.
Как добавить WorkFlow на GitHub
С помощью workflow мы можем добавить последние записи из блога или, например, ваши последние видео на youtube. Выглядит это следующим образом:
Для этого нужно:
1. Добавить следующий фрагмент кода:
2. Создать папку .github и внутри неё еще одну папку workflows , если она не существует.
3. В этой папке создать файл blog-post-workflow.yml
(в примере я выводил последние видео с youtube, поэтому выбрал другое название)
4. Добавить в файл следующий код:
name: Latest blog post workflow on: schedule: # Run workflow automatically - cron: '0 * * * *' # Runs every hour, on the hour workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the GitHub Actions Workflow page directly jobs: update-readme-with-blog: name: Update this repo's README with latest blog posts runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 - name: Pull in dev.to posts uses: gautamkrishnar/blog-post-workflow@v1 with: feed_list: "https://dev.to/feed/gautamkrishnar,https://www.gautamkrishnar.com/feed/"5. Заменить приведенный выше список URL-адресов собственными адресами. Для этого будет полезна ссылка, перейдя по которой, вы найдете необходимые ссылки для подгрузки ваших постов из популярных источников: Youtube, Medium, Reddit, Dev.to, WordPress и т.д.
6. Теперь нужно коммитнуть изменения и подождать, пока код отработает, либо же запустить его в ручную.
Для того чтобы узнать, как это сделать, лучше всего посмотреть сегмент в данном видео, в нем мы проходим по каждому из вышеперечисленных шагов и меняем все необходимое.
Как отобразить статистику GitHub профиля
Напоследок, осталось разобраться с выводом статистики в GitHub Profile Readme. Для этого мы воспользуемся следующим репозиторием: https://github.com/anuraghazra/github-readme-stats
Добавление статистики профиля может быть произведено всего одной строчкой кода:
[](https://github.com/anuraghazra/github-readme-stats)Единственное, что нужно сделать — это указать в ?username= имя вашего пользователя.
Для настройки и стилизации бейджа со статистикой рекомендуется перейти в вышеуказанный репозиторий и найти необходимые вам настройки.
Полезные ссылки:
Кастомизация профиля GitHub: Readme
Данная фича позволяет кастомизировать свой профиль на Github и сделать его более персонифицированным.
Создание Readme для профиля
Для этого необходимо добавить файл README в корень публичного репозитория, название которого совпадает с вашим именем пользователя. В результате README автоматически появится на странице вашего профиля.
При создании вы увидите плашку, сообщающую что вы нашли новую функцию и что это специальный репозиторий.
Далее вы можете использовать разметку Markdown (GitHub Flavored Markdown) для того чтобы соответствующим образом оформить свой профиль.
Проявив немного фантазии и задействовав Github Actions можно сделать ваш профиль довольно интересным. Например динамически обновлять информацию, подгружая её со сторонних сервисов посредством API.
Таким образом GitHub становится еще больше похожим на соцсеть, хоть и для IT специалистов или людей близких к IT.
Не могу обойти стороной репозиторий Awesome GitHub Profile README, там можно поискать идеи для оформления своего профиля.
Или же просто посмотреть как выглядят креативно оформленные профили других пользователей.
Так-же несколькими из пользователей Github создан проект упрощающий создание файла Readme.
На этом пожалуй закончу, удачи в оформлении профиля GitHub!
Upd: Дополнил опрос вариантами
- Знаю о этой фиче и уже использую
- Знаю о этой фиче, не использую