Владислав Калачев

Profile README для вашего GitHub профиля

8

Доброго времени суток, друзья. Сегодня поговорим на тему прокачки вашего профиля на GitHub. Не так давно появилась новая «фича» для оформления профиля, благодаря написанию README файла. Это очень похоже на то, как вы обычно заполняете README для ваших проектов, с тем отличием, что Profile README описывает вас как разработчика и человека со своими интересами и хобби. Если вы знаете markdown, то сложностей при заполнении Profile README у вас быть не должно. Поняв, что вообще такое Profile README и для чего он нужен, теперь стоит перейти к его созданию и непосредственно заполнению.

Видео на эту тему.

Как добавить Profile README

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

Так GitHub подсказывает нам, что этот репозиторий будет использован в качестве Profile README. Прежде чем создать репозиторий, убедитесь, что у вас стоят галочки напротив того, что данный репозиторий публичный, и вы хотите создать README файл, после чего смело кликаете на создание новой репы.

В общем-то это все что вам нужно для работы с Profile README и теперь на главной странице своего профиля вы можете увидеть демо Profile README с дефолтным описанием профиля. 

Осталось отредактировать по своему вкусу сам README. Давайте посмотрим на имеющиеся у нас варианты его заполнения.

Примеры Profile README

Есть несколько опций как вы сможете редактировать Profile README (перечислю самые распространенные):

— через сам github (открыв нужный файл и кликнув на кнопку edit this file);

— сделав git clone проекта и работать в своем любимом редакторе у себя на компьютере.

Выбирайте любой более удобный для вас способ. В файле README.md можно писать любой текст, добавлять ссылки на ваши ресурсы, добавлять картинки и даже небольшие «виджеты».

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

— Приветствие. Привет, меня зовут Вася / Hi there, I’m Vasya

— Кто я такой? Опыт работы, чем интересуюсь, какие языки программирования практикую и т.д.

— Как связаться со мной? Ваши контакты в соц сетях, e-mail и не только.

— Мои последние работы. Тут все просто. Укажите список ваших работ, к ним могут относится любые ваши проекты, задумки, open source, pet project.

— Мои последние статьи (если у вас есть блог). В этом пункте вы можете указать несколько своих статей со ссылками на них (чтобы не писать каждый раз статьи руками, можно воспользоваться решением для автоматизации https://github.com/gautamkrishnar/blog-post-workflow)

— Мои YouTube видео. Аналогично пункту с блогом. Если у вас есть свой YouTube канал, можете указать пару названий видео со ссылками на них (для автоматизация сбора последних видео вам так же подойдет решение https://github.com/gautamkrishnar/blog-post-workflow).

— Статистика по вашему github. Это сервис (репозиторий тут https://github.com/anuraghazra/github-readme-stats) который генерит на основе github api статистику по вашему github аккаунту. Подробно о том, что умеет этот сервис вы можете посмотреть почитав документацию, она довольно простая. Выглядит симпатично.

Имеется еще ряд виджетов и сервисов, разбирать которые в данной статье мы не будем (например, Spotify playing, сервисы подписок и т.д.)

Заключение

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

Подписывайтесь на наш канал в Telegram для получения самой последней и актуальной информации. 

1+

Комментарии:

Profile README для вашего GitHub профиля: 1 комментарий

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

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