shields

このリポジトリは、SVG およびラスター形式の簡潔で一貫性があり読みやすいバッジを提供するサービス Shields.io の拠点です。README には、バッジを GitHub の README やその他の Web ページに埋め込めることが記載されています。このサービスは、数十の継続的インテグレーションサービス、パッケージレジストリ、ディストリビューション、アプリストア、ソーシャルネットワーク、コードカバレッジサービス、コード分析サービスをサポートしていると述べています。毎月 16 億枚を超える画像を配信しており、VS Code、Vue.js、Bootstrap などのプロジェクトで使用されているとしています。リポジトリには、Shields.io のフロントエンドとサーバーコード、バッジを生成するための NPM ライブラリ badge-maker、バッジ設計仕様が含まれています。挙げられている例には、コードカバレッジ率、安定リリースバージョン、パッケージマネージャーリリース、依存関係ステータス、静的コード分析グレード、SemVer バージョン、週次の Liberapay 寄付、Python パッケージのダウンロード数、Chrome Web Store 拡張機能の評価、Uptime Robot の稼働率が含まれます。ユーザーは URL パターンを使ってカスタムバッジを作成できます。README では、ユーザーがバッジの完全なリストを閲覧し、カテゴリを検索または閲覧し、バッジをクリックしてユーザー名やリポジトリなどの必要なデータを入力し、必要に応じてラベルと色をカスタマイズし、GitHub の README やその他の Web ページ用にバッジ URL またはスニペットをコピーするクイックスタートが説明されています。コントリビューションは issue と pull request を通じてコミュニティベースで行われます。README は、サービスを追加または変更する際にテストを追加するようコントリビューターに求め、バッジを追加するチュートリアルを案内しています。また、good first issues とセキュリティポリシーにも言及しています。開発については、README に Node 24 のインストール、リポジトリのクローン、npm ci、npm start の実行、localhost:3000 を開くことが記載されています。サーーソースの変更は nodemon で再起動され、フロントエンドの変更は Docusaurus 開発サーバーでリロードされます。バッジ定義は最初のサーバー起動前にビルドされ、npm run prestart または再起動で再生成できます。バッジは npm run badge を使ってコマンドラインからデバッグでき、完全な URL も含められます。スナップショットテストが SVG または JSON 出力を保護します。意図的な出力変更は SNAPSHOT_DRY=1 npm run test:package でプレビューでき、SNAPSHOT_UPDATE=1 で更新できます。サーバーはオプションで Sentry と Prometheus を使用できます。セルフホスティングのドキュメントがリンクされています。関連プロジェクトには、キュレーションされたコレクションである awesome-badges があります。README には歴史も記載されています。b.adge.me が元のサイトで、gh-badges の 2013 年のコードを使用していました。プロジェクトは shields.io と統合されました。元のバッジ仕様は 2013 年に開発され、後に 2014 年に再設計されました。古いデザインは plastic style と呼ばれ、新しいデザインは flat style です。メンナーと卒業生がリストされており、プロジェクトは MIT と Apache 2.0 の下でデュアルライセンスされています。コミュニティの資金調達とサポートへのリンクもあります。