Github recommendations
0. Общие рекомендации
- Пользуйтесь всеми возможностями платформы: указывайте описание для своей персональной страницы в гитхабе
- Описание должно быть коротким, понятным, по возможности используйте текст, а не изображения, потому что ваш профиль могут смотреть не только разработчики, ваш профиль могут автоматически обрабатывать и доставать только текст, ваш профиль могут смотреть люди с различными нарушениями зрения, вы же не забыли указать
alt
на всех картинках :)?
- Дайте из вашего профиля ссылку на ваше резюме: ну вдруг рекрутер поделился только ссылкой на гитхаб, а тут и резюме под рукой
- Убедитесь, что в вашем аккаунте указана та почта, на которую вам можно написать: помните, про автоматическую обработку, человеческий фактор
- Не указывайте иконку GMail, которая ведет на почту на yandex.ru :)
- Запиньте только те репозитории, которые хотите, чтобы просмотрели. Редко кто заходит на список всех репозиториев
- Помните, что у разработчиков еще меньше времени чем у рекрутеров, старайтесь делать максимально просто, комфортно: пишите короткие описания, давайте ссылки, подсказывайте тому, кто смотрит ваш Gh – куда ему стоит заглянуть в первую очередь и что он там найдет
1. Внутри репозитория
Большая вероятность, что в начале вашего пути, в списке ваших репозиториев будут только учебные или личные проекты
Поэтому давайте сначала поговорим о том, чего не стоит делать:
Не делайте так
- не форкайте репозитории без изменений, без пул-реквестов, выглядит так, как будто вы пытаетесь наполнить ваш гитхаб “водой”
- не закрепkяйте репозиторий у которого нет описания, а по истории коммитов ничего не понятно
- не закрепряйте репозитории, в которых один единственный коммит “initial commit” и всего одна ветка
main
Теперь о том, что стоит делать:
- README.md, при чем, если проект учебный, то постарайтесь написать не только “задание”, но так же дайте ссылку на проект, развернутый на сервере (на github-pages можно захостить любой статический сайт)
- Будет большим плюсом, если там же, в README, вы напишете: как именно вы выполняли задание, какие технологии использовали и чему научились (вспомните пояснительные записки к лабораторным)
- Если ваш проект подразумевает возможность запустить его локально – обязательно укажите это в описании, добавьте инструкцию по запуску
- Старайтесь всегда разрабатывать учебные или pet-проекты так, как вы бы разрабатывали коммерческий продукт: придерживайтесь стандартов разработки, пишите понятные сообщения к коммитам, придерживайтесь одного стиля, помните, что лучше хорошее сообщение к коммиту на русском, чем плохое на английском
- добавьте к вашим репозиториям github-badges, которые покажут покрытие кода тестами, прохождение линтеров и другую статистику, это положительно влияет на заинтересованности в вас нанимающего
- Прогоните все ваши файлы исходников через авто-форматер и авто-линтер :)
- А лучше – не поленитесь и поправьте и все то, на что поругается линтер, но поправить не сможет
2. Дополнительно
Переходим к высшему пилотажу: opensource, в начале вашей карьеры он может стать отличным бонусом ко всем другим вашим достижениям.
Вложения в opensource-проекты однозначно покажут, что вы заинтересованы в разработке, можете разобраться с чужим кодом, а не только писать свой, можете коммуницировать с другими разработчиками
Рекомендации по тому, где найти задачи для Open Source: