Советы по улучшению вашего профиля на GitHub | Техрокс | Журнал "Вольт"
Чт. Окт 29th, 2020


Перевод статьи «Советы для вашего портфолио на GitHub».

Несколько недель назад два человека задали мне один и тот же вопрос: «Как вы можете улучшить свой профиль GitHub?»

Поскольку меня спрашивают об этом не впервые, я решил ответить публично.

Прежде чем мы начнем, я хотел бы кое-что подчеркнуть. Профиль GitHub не требуется и не требуется. Относится к категории «если есть – хорошо».

Качество важнее количества

Такие профили на GitHub встречаются довольно часто:

Человек выбрал шесть репозиториев и зафиксировал их. У всех этих репозиториев есть три фиксации и нет readme. Вроде бы этот разработчик любит экспериментировать, но ничего впечатляющего так и не создал. Если рекрутер спросит: «С какой проблемой вы столкнулись при работе над этим проектом и как вы ее решили?», Будет мало возможностей для хорошего ответа.

Не поймите меня неправильно: нет ничего плохого в экспериментах с новыми технологиями! Мой собственный профиль на GitHub также полон проектов “hello world”. Но в моем профиле они не исправлены. Я лишь подкрепляю то, что кажется важным и подходящим для данного случая. Я знаю, что у рекрутеров нет времени изучать все мои проекты. Следовательно, на момент написания этой статьи у меня было пять приколов.

В общем, вместо того, чтобы показывать шесть небольших проектов, выберите один и хорошо его отполируйте.

Учиться публично

«Не загружайте несовершенные проекты на GitHub».

Так сказал один старший разработчик, с которым мне довелось работать. Я считаю, что это неправильный подход. Вообще говоря, люди, которые боятся ошибиться, никуда не денутся. Взгляните на популярные репозитории на GitHub: большинство из них далеки от совершенства. И это здорово!

Вдобавок, если однажды кто-то вдруг захочет изучить git-log вашего проекта и обнаружит, что вы забыли круглую скобку (или точку с запятой), я не думаю, что этот человек будет жаловаться на это. Но даже если это произойдет, считайте, что вам повезло: у вас появился шанс сразу понять, что вы не хотите работать с этим человеком.

Всегда есть что улучшить!

Однажды я был наставником для девушки, которая хотела «войти в IT». Она показала мне небольшую игру, которую разработала сама. Но в то же время ей хотелось подобрать себе новый проект, потому что этот был «закончен».

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

В частности, даже когда кажется, что проект завершен, вы все равно можете сделать кое-что. Например…

Добавить README.md

Файл README – это отправная точка для вашего проекта. Это первое, что видят люди!

Думаю, такой файл должен быть в каждом репозитории. Даже если вы не хотите, чтобы люди интересовались вашим проектом, вы все равно можете добавить README и написать в нем: «Здесь нечего смотреть, прокрутите дальше!».

Ваш README должен ответить на следующие вопросы:

  • Что (зачем был создан этот проект)? (1-2 предложения будет достаточно).
  • Как мне его установить?
  • Как это использовать?
  • Как это выглядит в готовом виде (в действии)? Вы можете добавить скриншот или гифку.

Совет… Для вдохновения загляните в репозиторий Awesome README.

Заниматься маркетингом

Если вы создаете приложение, продвигайте его! Мой бывший коллега создал минималистичный текстовый редактор. Этот разработчик не упускает возможности опубликовать ссылку на свой проект в социальных сетях (Twitter, LinkedIn …) и рассказать о том, что это за продукт и какие новые функции были добавлены в него. Он также добавил этого своего редактора в ProductHunt / Reddit. Это отличные платформы для сбора отзывов!

Добавить новую функциональность

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

В какой-то момент вы можете дойти до того момента, когда вам придется переосмыслить, как вы написали свое приложение. Это отлично! Итак, вы уже прошли этап «Hello world». Обычно по мере роста проекта начинают появляться более интересные задачи.

А также …

  • Ведите список задач, используя тикеты (или задачи). Если у вас несколько заявок, вы можете сгруппировать их по категориям: «ошибка», «улучшение» … И если люди найдут ошибку или захотят отправить запрос на добавление новых функций, они могут открыть «проблему» в вашем репозитории! Небольшой совет: перед добавлением нового функционала исправьте все найденные ошибки!
  • Пишите тесты! Многие рекрутеры, глядя на код, обращают внимание на наличие тестов. Напишите их для проекта, над которым вы сейчас работаете!
  • Добавьте непрерывную интеграцию (CI). Таким образом, каждый раз, когда вы добавляете код, робот будет проверять, прошли ли тесты и есть ли у вас «мертвый» код. Здесь вы можете использовать такие инструменты, как TravisCI или GitHub Actions.
  • Автоматизируйте развертывание. Многие инструменты позволяют развернуть в Интернете сразу же, когда вы нажимаете git push на главную ветку. Ознакомьтесь с Netlify, GitHub / GitLab Pages, Vercel.
  • Сделайте ваше приложение доступным, чтобы им могли пользоваться люди с ограниченными возможностями.
  • Сделайте свое приложение мобильным (адаптивный веб-дизайн). Если вас это устраивает, попробуйте создать прогрессивное веб-приложение (PWA).
  • Как насчет монетизации? Если вы думаете, что ваш продукт решает проблемы многих людей, стоит подумать о монетизации. Этот проект может принести вам кофе (и не только)!



Source link

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *