shields
1.0.0
Это является домом для Shields.io, услуга для кратких, последовательных и разборчивых значков в формате SVG и растровых, которые могут быть легко включены в чтения GitHub или любую другую веб -страницу. Сервис поддерживает десятки служб непрерывной интеграции, реестров пакетов, распределений, магазинов приложений, социальных сетей, служб покрытия кода и сервисов анализа кода. Каждый месяц он обслуживает более 1,6 миллиарда изображений и используется некоторыми из самых популярных в мире проектов с открытым исходным кодом, VS Code, Vue.js и Bootstrap.
Это репошет:
Сделайте свои собственные значки! (Быстрый пример: https://img.shields.io/badge/left-right-f39f37 )
Просмотрите полный список значков и найдите конкретный значок, используя строку поиска или просмотрев категории. Нажмите на значок, чтобы заполнить необходимые элементы данных для этого типа значка (например, ваше имя пользователя или репо) и необязательно настраивать (метку, цвета и т. Д.). И это готово к использованию!
Используйте кнопку внизу, чтобы скопировать URL или фрагмент значка или фрагмент, который затем можно добавить в такие места, как ваши файлы README GitHub или другие веб -страницы.
Шилдс - это общественный проект. Мы приглашаем ваше участие через проблемы и привлекуте запросы! Вы можете просмотреть руководящие принципы.
При добавлении или изменении услуги добавьте тесты.
Этот проект имеет довольно невыполнение предложений! Если вы новичок в проекте, возможно, вы хотите открыть запрос на привлечение, чтобы обратиться к одному из них.
Вы можете прочитать учебник о том, как добавить значок.
Если вы намерены отчетность или внести исправление, связанное с уязвимостью безопасности, пожалуйста, сначала обратитесь к нашей политике безопасности.
npm ci , чтобы установить зависимости.npm start сервер значков и сервер Frontend Dev.http://localhost:3000/ для просмотра фронта. Когда исходные файлы сервера изменяются, сервер значков должен автоматически перезапустить себя (с помощью Nodemon). Когда фронтальные файлы изменяются, Frontend Dev Server ( docusaurus start ) также должен автоматически перезагрузить. Однако определения значков создаются только до того, как сервер впервые запускается. Чтобы регенерировать их, запустите npm run prestart , либо вручную перезапустить сервер.
Чтобы отлаживать значок из командной строки, запустите npm run badge -- /npm/v/nock . Он также работает с полными URL -адресами, такими как npm run badge -- https://img.shields.io/npm/v/nock .
Используйте npm run debug:server для запуска сервера в режиме отладки. Этот рецепт показывает, как отлаживать приложение Node.js в VS -коде.
Shields обладает экспериментальной поддержкой Gitpod, предварительно сфигурированной среды разработки, которая работает в вашем браузере. Чтобы использовать Gitpod, нажмите кнопку ниже и войдите в GitHub. Gitpod также предлагает дополнение браузера, хотя это не требуется. Пожалуйста, сообщите о любых ошибках Gitpod, вопросах или предложениях в выпуске № 2772.
Тесты снимка гарантируют, что мы непреднамеренно вносят изменения, которые влияют на выход SVG или JSON. При преднамеренном изменении вывода запустите SNAPSHOT_DRY=1 npm run test:package для предварительного просмотра изменений в сохраненных снимках и SNAPSHOT_UPDATE=1 npm run test:package для их обновления.
Сервер может быть настроен для использования Sentry (Configuration) и Prometheus (Configuration).
Наш полный тестовый набор, а также покрытие кода выполняются ежедневно.
Есть документация о размещении собственного сервера.
Значки статуса широко используются в проектах с открытым исходным кодом и частным программным обеспечением. Академики изучали значки «сигнала» о качестве программного проекта. Существует много существующих библиотек для отмены этих значков и альтернативы обслуживанию значков размещенных щитов. Awesome Badges-это кураторская коллекция таких ресурсов. Взносы могут быть рассмотрены там. (Присутствие проекта в этой коллекции не должно интерпретироваться как одобрение и продвижение из проекта Shields)
B.Adge.me был оригинальным веб -сайтом для этой услуги. У Хероку тогда была вещь, которая затрудняла использование с ним домена Toplevel, отсюда и нечетный домен. Он использовал код, разработанный в 2013 году из библиотеки под названием GH-Badges, оба разработанных Thaddée Tyl. Проект объединился с Shields.io, заставив его использовать код B.Adge.me и закрытый B.Adge.me.
Оригинальная спецификация значка была разработана в 2013 году Оливье Лаканом. Это было вдохновлено Travis CI и похожими значками (тогда их было намного меньше). В 2014 году Тэдде -Тайл перепроектировал его с помощью сотрудника Travis CI и убедил всех переключиться на него. Старый дизайн - это то, что сегодня называется пластиковым стилем; Новый - это плоский стиль.
Вы можете прочитать больше о создании проекта, мотивации спецификации значка SVG и самой спецификации.
Содействия:
Выпускники:
Все активы и код находятся под лицензией CC0 и в общественном достоянии, если не указано иное.
Благодаря людям и компаниям, которые жертвуют деньги, услуги или время, чтобы поддерживать работу проекта. https://shields.io/community
