Узнайте, как эффективно управлять своим репозиторием GitHub для привлечения и удержания участников с помощью функции бейджей 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 демонстрирует общее количество звезд, коммитов, Pull Requests, Issues и Contributions вашего репозитория GitHub
- Звезды : Пользователи сохраняют репозитории GitHub (как закладки). Это означает, что пользователь заинтересован в сохраненном хранилище и хочет оставаться в курсе событий. Однако хранилище, отмеченное звездочкой, не может быть отредактировано.
- Commits : Сохранение изменений в хранилище называется фиксацией. К коммиту добавляются различные детали содержание, сообщение (описание), имя автора и метка времени.
- Pull Request : Pull Request информирует других об улучшениях, которые вы разместили в другом репозитории GitHub, кроме вашего. Мы часто называем Pull Request сердцем GitHub Collaboration.
- Issues : GitHub Issues используются для получения обратной связи от пользователей, отслеживания идей, улучшений и перечисления ошибок, о которых было сообщено в репозиторий.
- Contribution : GitHub Contributions показывает количество вкладов, которые были сделаны в другие репозитории. Вклад может быть сделан с помощью Pull Request.
.
Чтобы добавить значок GitHub Stats в ваш репозиторий, вставьте приведенный ниже код Markdown в файл README.md
! Your Repository's Stats (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 написано больше всего кода. Языки перечислены в порядке убывания
Связанное: Какой язык программирования следует изучать?
Чтобы добавить значок Most Used Languages в ваш репозиторий, вставьте приведенный ниже Markdown в ваш файл README.md
! Your Repository's Stats (https://github-readme-stats.vercel.app/api/top-langs/?username=Your_GitHub_Username&theme=blue-greenЕдинственный недостаток этого значка в том, что в нем не указан Markdown как наиболее часто используемый язык
3. Значок контрибьютора
Значок контрибьюторов отображает все операции, такие как добавления , удаления и фиксации , которые были выполнены в ваших репозиториях. Когда вы объединяете запрос на притяжение с вашим репозиторием, человек, создавший запрос, будет добавлен в качестве соавтора. Это действительно хорошая привычка – отмечать вкладчиков, которые потратили свое время на создание обновлений в вашем хранилище
Значок вкладчиков может быть создан с помощью contributors-img, веб-приложения, которое генерирует изображение для отображения списка вкладчиков
Генерирование изображения участника довольно тривиально. Перейдите на сайт contributors-img и вставьте название вашего репозитория вместе с имя пользователя для генерации URL. В качестве альтернативы просто вставьте приведенный ниже код Markdown, чтобы получить изображение
! GitHub Contributors Image (https://contrib.rocks/image?repo=Your_GitHub_Username/Your_GitHub_Repository_Name4. Генератор случайных шуток
Генератор случайных шуток будет генерировать техническую шутку в форме вопросов и ответов. Например, ‘ Что такое компьютерный вирус? Терминальная болезнь ‘
Чтобы использовать значок, вам нужно вставить Markdown-код в ваш файл README.md, как показано ниже
## 😂 Here is a random joke that'll make you laugh!
! Jokes Card (https://readme-jokes.vercel.app/api5. Счетчик просмотра профиля
Бейдж Profile View Counter отображает количество просмотров вашего профиля на GitHub в вашем профиле. Чтобы сгенерировать этот значок, вставьте следующий код Markdown:
! Profile View Counter (https://komarev.com/ghpvc/?username=Your_GitHub_UsernameЧтобы получить количество просмотров вашего репозитория, вы можете использовать значок HITS ( How Idiots Track Success ). Это простой способ узнать, сколько людей посетили ваш репозиторий GitHub :
! Hits (https://hitcounter.pythonanywhere.com/count/tag.svg?url = Paste_Your_GitHub_Repository_Link_HereНо недостатком как счетчика просмотров профиля, так и HITS является то, что они не отображают счетчик просмотров с уникальными ID. Каждый раз, когда вы перезагружаете браузер/хранилище, счетчики увеличиваются. Можно легко получить больше просмотров, обновив страницу
Полная реализация бейджей GitHub
В качестве примера я использовал свой репозиторий GitHub. Чтобы генерировать бейджи, рекомендуется добавить эти коды в указанный вами файл README.md. Если у вас нет файла README.md в вашем репозитории GitHub, то лучшим вариантом будет создать его вручную
# Top 5 Badges That Will Take Your GitHub Repository to the Next Level
## 1. GitHub Stats
! Your Repository's Stats (https://github-readme-stats.vercel.app/api?username=Tanu-N-Prabhu&show_icons=true
## 2. Most Used Languages
! Your Repository's Stats (https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue-green
## 3. Contributors Badge
! Your Repository's Stats (https://contrib.rocks/image?repo=Tanu-N-Prabhu/Python
## 4. Random Joke Generator
! Jokes Card (https://readme-jokes.vercel.app/api
## 5. Profile View Counter
! Profile View Counter (https://komarev.com/ghpvc/?username=Tanu-N-Prabhu
### Repository View Counter - HITS
! Hits (https://hitcounter.pythonanywhere.com/count/tag.svg?url=https://github.com/Tanu-N-Prabhu/PythonНет необходимости выполнять или запускать приведенный выше фрагмент кода в файле README.md. Как только вы сохраните файл с расширением (.md), GitHub автоматически выполнит вывод, и изменения будут непосредственно отражены в вашем репозитории
Доступно больше значков GitHub
Теперь, когда вы знаете, как добавить значки GitHub в свой репозиторий, это отличный вариант для разработчиков и частных лиц, которые могут использовать эти значки для повышения читаемости своих репозиториев. Это не так уж сложно – все, что вам нужно сделать, это вставить несколько строк кода Markdown для создания значков
Чем больше значков вы включите в свой репозиторий, тем больше внимания вы привлечете. Один значок способен предоставить полезную информацию в виде статистики, статуса и метрик
Комментировать