Перевод статьи «Tips for your GitHub Portfolio».
Несколько недель назад сразу два человека задали мне один и тот же вопрос: «Как можно улучшить свой GitHub-профиль?»
Поскольку это не первый раз, когда меня об этом спрашивают, я решил ответить публично.
Прежде чем начать, хотелось бы кое-что подчеркнуть. Профиль на GitHub не является и не должен являться чем-то обязательным. Он относится к разряду «если есть — хорошо».
Качество важнее количества
Такие профили на GitHub встречаются довольно часто:
Человек выбрал шесть репозиториев и закрепил их. Все эти репозитории имеют по три коммита и никаких readme. Создается впечатление, что этот разработчик любит экспериментировать, но так и не создал ничего впечатляющего. Если рекрутер спросит: «С какой проблемой вы столкнулись при работе над этим проектом и как ее решили?», возможностей для красивого ответа будет мало.
Не поймите меня неправильно: нет ничего дурного в том, чтобы экспериментировать с новыми технологиями! У меня самого в профиле на GitHub тоже полно «hello world»-проектов. Но в моем профиле они не закреплены. Я закрепляю только то, что мне кажется важным и подходящим к случаю. Я знаю, что у рекрутеров нет времени изучать все мои проекты. Поэтому на момент написания этой статьи у меня пять закрепленных.
В общем, вместо того чтобы показывать шесть маленьких проектов, выберите один и хорошенько его «отполируйте».
Учитесь публично
«Не выкладывайте на GitHub неидеальные проекты».
Так говорил один разработчик-сеньор, с которым мне довелось работать. Я думаю, это неверный подход. Если брать в целом, люди, которые боятся допускать ошибки, так ничего и не достигают. Посмотрите на популярные репозитории на GitHub: большинство из них далеки от совершенства. И это прекрасно!
Кроме того, если однажды кто-нибудь вдруг захочет изучить git-лог вашего проекта и обнаружит, что вы забыли скобку (или точку с запятой), я не думаю, что этот человек выскажет вам претензии по этому поводу. Но даже если такое произойдет, считайте, что вам повезло: вы получили шанс сразу понять, что с этим человеком вы работать не захотите.
Всегда есть, что усовершенствовать!
Однажды я выступал в роли наставника для девушки, которая хотела «войти в айти». Она показала мне маленькую игру, которую сама разработала. Но при этом она хотела подобрать себе новый проект, потому что этот был «закончен».
Проект никогда не может быть закончен. Всегда есть, что улучшить. Помните о первом правиле: качество важнее количества.
Если говорить более конкретно, то даже когда проект вроде бы завершен, вы все равно можете кое-что сделать. Например…
Добавить README.md
Файл README это начальная точка вашего проекта. Это первое, что видят люди!
Я думаю, такой файл должен быть в каждом репозитории. Даже если вы не хотите, чтобы люди интересовались вашим проектом, все равно можно добавить README и написать в нем: «Нечего здесь смотреть, листайте дальше!».
Ваш README должен отвечать на следующие вопросы:
- О чем (для чего создан) этот проект? (1-2 предложений будет достаточно).
- Как его установить?
- Как им пользоваться?
- Как это выглядит в готовом виде (в действии)? Можно добавить скриншот или gif-анимацию.
Совет. Для вдохновения можно изучить Awesome README repository.
Заняться маркетингом
Если вы создаете приложение — продвигайте его! Один мой бывший коллега создал минималистичный текстовый редактор. Этот разработчик не упускает случая опубликовать ссылку на свой проект в соцсетях (Twitter, LinkedIn…) и рассказать о том, что это за продукт и какие новые функции в него добавлены. Он также добавил этот свой редактор на ProductHunt/Reddit. Это отличные платформы для сбора отзывов!
Добавить новый функционал
Когда у вас на руках проект, созданный с нуля, вам будет совсем не трудно придумать, какие функции в него добавить. Если вы пробовали продвигать этот продукт или собрали отзывы друзей и родственников, у вас уже должен быть список идей.
На каком-то этапе вы можете дойти до точки, когда вам придется переосмыслить то, как вы написали свое приложение. Это отлично! Значит, вы уже прошли стадию «Hello world». Обычно по мере роста проекта начинают попадаться более интересные проблемы.
А еще…
- Ведите список задач с использованием тикетов (или issues). Если у вас есть несколько тикетов, можете сгруппировать их по категориям: «баг», «улучшение»… И если люди обнаружат баг или захотят отправить запрос на новый функционал, они, возможно, откроют «issue» в вашем репозитории! Маленький совет: прежде, чем добавлять новый функционал, исправляйте все обнаруженные баги!
- Пишите тесты! Многие рекрутеры, просматривая код, обращают внимание на наличие тестов. Напишите их для проекта, над которым работаете сейчас!
- Добавьте непрерывную интеграцию (CI). Таким образом каждый раз при добавлении кода робот будет проверять, пройдены ли тесты и нет ли у вас «мертвого» кода. Здесь можно использовать такие инструменты как TravisCI или GitHub Actions.
- Автоматизируйте развертывание. Многие инструменты позволяют осуществлять деплоймент в веб сразу при выполнении git push в ветку master. Обратите внимание на Netlify, GitHub/GitLab Pages, Vercel.
- Сделайте ваше приложение доступным, чтобы им могли пользоваться люди с ограниченными возможностями.
- Сделайте свое приложение mobile friendly (с отзывчивым веб-дизайном). Если с этим у вас не возникает проблем, попробуйте создать прогрессивное веб-приложение (PWA).
- Как насчет монетизации? Если вы считаете, что ваш продукт решает проблему многих людей, стоит задуматься о монетизации. Этот проект может заработать вам на кофе (и не только)!
[customscript]techrocks_custom_after_post_html[/customscript]
[customscript]techrocks_custom_script[/customscript]