Как создать хороший профиль на GitHub?

2
643
views

Перевод статьи «What Makes a Good GitHub Profile?»

Photo by AltumCode on Unsplash

Когда я, учась в колледже, подавала заявки на стажировку, я определенно недооценивала GitHub. За время учебы я создала довольно много проектов. Мне даже пришлось к каждому приложить подробное описание, которое можно было бы с легкостью преобразовать в README. Тем не менее я не потрудилась загрузить эти проекты в свой профиль на GitHub и поддерживать их. Однако со временем (довольно быстро) я поняла, что это было упущенной возможностью.

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

Кто получает наибольшую выгоду от проектов на GitHub?

Самую большую пользу проекты, размещенные на GitHub, приносят людям, впервые ищущим работу. Это студенты университетов, вчерашние выпускники, а также люди, прошедшие обучение на курсах. У них нет профессионального опыта в сфере разработки, а потому личные проекты лучше всего могут показать их способности и умения.

Также наличие проектов на GitHub может пригодиться опытным разработчикам, желающим сменить работу. Если программист на текущей работе не сталкивается со сложными и интересными задачами, если ему приходится писать код на «немодных» языках, такому программисту будет сложно найти работу с современным техническим стеком. Если, конечно, он не покажет свой опыт работы с современными технологиями. А показать можно на личных проектах.

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

Включайте в каждый репозиторий хорошо составленный README

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

  1. имеете хорошие навыки коммуникации,
  2. думаете о том, что важно для проекта в долгосрочной перспективе.

Составляя документацию, обязательно указывайте назначение вашего проекта и варианты его использования. Также следует включить инструкции по установке, чтобы пользователи могли легко запустить и использовать любой созданный вами инструмент. Наконец, включите в документацию демо (скриншоты или гифки — дополнительный плюс!) или ссылку на демо, чтобы пользователи могли без проблем посмотреть, как все работает.

Пишите чистый, хорошо организованный код

Photo by CHUTTERSNAP on Unsplash

Умение писать чистый код — обязательный навык для работы в команде. Когда члены команды или менеджеры видят у кандидата код, с которым им было бы проблемно работать, это зачастую отворачивает их от этого кандидата. Так же как и хороший файл README, хорошо организованный код — отличный способ произвести прекрасное впечатление. Создавайте функции для повторяющегося кода и подчищайте код при помощи линтеров — это часть лучших подходов.

Включайте в свой код комментарии — при необходимости или в соответствии с общепринятой практикой для вашего языка. Например, в Python следует прописывать Docstrings в функциях.

Старайтесь не переусердствовать с комментариями. Чтобы убрать лишние комментарии, постарайтесь подобрать переменным осмысленные имена и максимально упростить сам код (избегайте слишком заумных приемов). Ваши комментарии должны больше фокусироваться на цели написания кода.

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

Поддерживайте активность

Ваши квадратики должны быть зелеными! Это показатель вашей активности на платформе и постоянной работы с кодом, а с точки зрения менеджеров по найму это плюс.

Общее правило следующее: обновляйте свой код и делайте коммиты почаще. Работаете над учебным проектом? Обновляйте репозиторий по мере продвижения. Кстати, в маленьких проектах нет ничего плохого. Главное, следите за тем, чтобы они были разными и демонстрировали разные навыки.

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

Помимо коммитов с изменениями, вы можете делать и другие вещи для поддержания активности на GitHub. Например:

  • открывать issue
  • предлагать пул-реквест
  • делать ревью пул-реквестов.

У вас на работе тоже используется GitHub? Вы можете включить Private contributions, чтобы ваша активность отображалась в вашем профиле.

Используйте GitHub Pages

GitHub Pages — отличный инструмент, позволяющий разместить веб-страницу прямо из репозитория. Таким образом вы сможете моментально показать пользователю результат вашего проекта.

Например, если ваш проект — это сайт, вам потребуется всего лишь нажать несколько кнопок, и GitHub Pages разместит вашу страницу index.html. Более того, любые изменения, которые вы запушите, отразятся на размещенной странице даже без всякого развертывания.

Наличие демо или домашней страницы проекта может иметь ключевое значение для демонстрации ваших навыков. Если не знаете, как разместить демо, обратите внимание на GitHub Pages: это прекрасный вариант.

Информация о вас, указанная в профиле

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

Чтобы сразу произвести хорошее впечатление на посетителей, вы можете отобрать свои самые лучшие проекты и закрепить эти репозитории на странице.

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

Прочие советы

  • Не пренебрегайте возможностью добавить описание и теги к своим репозиториям. При этом будьте кратки и информативны.
  • Проявляйте профессионализм при написании сообщений коммитов. Пишите что-то более осмысленное, чем «fix bug» или «why won’t this work??» («почему это не работает??»).
  • Если предполагается, что другие люди тоже могут стать контрибьюторами вашего проекта, обязательно напишите четкое руководство, как им это сделать.
  • Удаляйте лишнее, например форки репозиториев, над которыми вы не работали.
  • Активно участвуйте в жизни сообщества, например, станьте контрибьютором в проектах с открытым кодом.

Заключение

Следуя этим советам, я смогла превратить свой профиль на GitHub в полезный инструмент для поиска работы. На собеседованиях мне задавали вопросы о моих проектах (а значит, рекрутеры просматривали профиль). Я всем рекомендую пользоваться GitHub как инструментом для поиска работы или даже просто для обеспечения своего присутствия онлайн. Удачи!

2 КОММЕНТАРИИ

  1. 1. Где узнать про README?
    2. Docstrings — если это многострочое комментирование?
    3.Git hib pages-это улитита? сервис? фреймворк? библиотека?

ОСТАВЬТЕ ОТВЕТ

Please enter your comment!
Please enter your name here