5 лучших значков, которые улучшат ваш репозиторий на GitHub

Значки GitHub могут повысить читаемость репозитория, предоставляя пользователям быстрый способ захвата метрик репозитория. Значки могут быть встроены в ваш README.md, чтобы прояснить важность и необходимость вашего проекта для других разработчиков. В результате читатели действительно быстро получают представление о репозитории, проверяя прикрепленные значки.

На сайте доступно множество значков GitHub. в Интернете, вот пять самых информативных значков для включения в файл README.md. Для каждого указанного значка предоставляется эквивалентный код Markdown.

Что могут сделать значки GitHub для вас?

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

Когда я создавал свой репозиторий Python Programming GitHub, я пропустил значки. В моем неукрашенном хранилище было правильное содержимое, но ничем не выделялось. Из-за этого репозиторий набрал очень мало трафика (уникальных посетителей).

Связано: как создать репозиторий GitHub

После добавления дополнительных значков в мой репозиторий я заметил автоматический рост числа внешних посетителей (с 5 до 767) в месяц. (просмотрите своих уникальных посетителей в Insights> Traffic в вашем репозитории.)

Мой почтовый ящик был заполнен комментариями о том, насколько хорошо мой репозиторий отличается от других репозиториев программирования Python — все из-за значков. Простой значок GitHub может полностью изменить внешний вид вашего репозитория.

Всегда помните: значок стоит 1000 строк кода.

1. Статистика GitHub

Значок GitHub Stats показывает общее количество звезд, коммитов, запросов на вытягивание, проблем и вкладов вашего GitHub репозиторий.

  1. Звезды : пользователи сохраняют репозитории GitHub (например, закладку). Это указывает на то, что пользователь заинтересован и желает оставаться в курсе сохраненного репозитория. Однако помеченный репозиторий нельзя редактировать.
  2. Фиксация : сохранение изменения в репозитории называется фиксацией. К фиксации добавляются различные сведения, содержимое, сообщение (описание), имя автора и отметка времени .
  3. Запрос на слияние : запрос на слияние информирует других об улучшениях, которые вы внесли в другой репозиторий GitHub, кроме вашего. Мы часто называем Pull Request сердцем совместной работы GitHub.
  4. Проблемы : проблемы GitHub используются для получения отзывов пользователей, отслеживания идей, улучшений и составления списка ошибок, сообщаемых в репозиторий.
  5. Вклад : вклад GitHub указывает количество вкладов, внесенных в другие репозитории. Взнос можно сделать с помощью запроса на слияние.

Чтобы добавить значок GitHub Stats в свой репозиторий, вставьте приведенный ниже код Markdown в свой README. md файл.

 ! [Статистика вашего репозитория] (https://github-readme-stats.vercel.app/api?username=Your_GitHub_Username&show_icons=true)  

Убедитесь, что вы изменили значение username = на имя пользователя GitHub. Значок GitHub Stats также предоставляет рейтинги, такие как S + (первые 1%), S (лучшие 25%), A ++ (лучшие 45%), A + (лучшие 60%) и B + (все) . Чем выше ваша статистика, тем выше ваш рейтинг.

2. Наиболее часто используемые языки

Как следует из названия, значок «Наиболее часто используемые языки» отображает наиболее распространенные языки, используемые в GitHub. Это показатель GitHub, показывающий, какие языки, такие как HTML, CSS, JavaScript, Python, Go, и другие, имеют наибольшее количество кода на GitHub. Языки перечислены в порядке убывания.

По теме: Какой язык программирования вам следует учить?

Чтобы добавить значок «Самые используемые языки» в свой репозиторий, вставьте Markdown ниже в свой файл README.md.

 ! [Статистика вашего репозитория] (https://github-readme-stats.vercel.app/api/top-langs/?username=Your_GitHub_Username&theme=blue-green)   

Единственным недостатком этого значка является то, что он не указывает Markdown как наиболее часто используемый язык.

3. Значок участника

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

Значок участников может быть создан с помощью вкладчиков-img, веб-приложения, которое генерирует изображение для отображения списка участников..

Создание изображения участника довольно тривиально. Перейдите на сайт Contributors-img и вставьте имя вашего репозитория вместе со своим именем пользователя , чтобы сгенерировать URL. Или просто вставьте код Markdown, приведенный ниже, чтобы получить изображение.

 ! [Изображение участников GitHub] (https://contrib.rocks/image?repo=Your_GitHub_Username/Your_GitHub_Repository_Name)  

4. Генератор случайных шуток

Генератор случайных шуток сгенерирует техническую шутку в виде вопросов и ответов. Например, « Что такое компьютерный вирус? Смертельная болезнь ».

Чтобы использовать значок, вам необходимо встроить код Markdown в файл README.md, как показано ниже.

  ## 😂 Вот случайная шутка, которая заставит вас смеяться! 
! [Карточка анекдотов] (https://readme-jokes.vercel. app/api)

5. Счетчик просмотров профиля

Значок счетчика просмотров профиля показывает, сколько раз ваш профиль GitHub был просмотрен в вашем профиле. Чтобы создать этот значок, вставьте следующий код Markdown:

 ! [Счетчик просмотра профиля] (  https://komarev.com/ghpvc/?username=Your_GitHub_Username)  

Чтобы сгенерировать количество просмотров вашего репозитория, вы можете использовать HITS ( Как идиоты следят за успехом ). Это простой способ узнать, сколько людей посетили ваш репозиторий GitHub :

 ! [Hits] (https://hitcounter.  pythonanywhere.com/count/tag.svg?url = Paste_Your_GitHub_Repository_Link_Here)  

Но недостатком как счетчика Profile View, так и HITS является то, что они не отображают количество просмотров с уникальными идентификаторами. Каждый раз, когда вы перезагружаете браузер/репозиторий, счетчики будут увеличиваться. Можно легко получить больше просмотров, обновив страницу.

Полная реализация значков GitHub

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

  # 5 лучших значков, которые поднимут ваш репозиторий GitHub на новый уровень 
## 1. Статистика GitHub
! [Статистика вашего репозитория] (https://github-readme-stats.vercel.app/api?username=Tanu-N-Prabhu&show_icons=true)
## 2. Наиболее часто используемые языки
! [Статистика вашего репозитория] (https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue- зеленый)
## 3. Значок участника
! [Статистика вашего репозитория] (https://contrib.rocks/image?repo=Tanu-N-Prabhu/Python)
## 4. Генератор случайных шуток
! [Карточка с анекдотами] (https://readme-jokes.vercel.app/api)
## 5. Счетчик просмотров профиля
! [Счетчик просмотров профиля] (https://komarev .com/ghpvc/? username = Tanu-N-Prabhu)
### Счетчик просмотра репозитория - HITS
! [Hits] (https://hitcounter.pythonanywhere.com/count/tag .svg? url = https://github.com/Tanu-N-Prabhu/Python)

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

Доступно больше значков GitHub

Теперь, когда вы знаете, как добавить значки GitHub в свой репозиторий, это отличный вариант для разработчиков и отдельных лиц, которые могут использовать эти значки для повышения читабельности своих репозиториев. . Это не так уж и сложно — все, что вам нужно сделать, это встроить несколько строк кода Markdown для создания значков.

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

Оцените статью
oilgasindustry.ru
Добавить комментарий