shields-badge 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. checksums.yaml +7 -0
  2. checksums.yaml.gz.sig +0 -0
  3. data/CHANGELOG.md +31 -0
  4. data/CODE_OF_CONDUCT.md +133 -0
  5. data/CONTRIBUTING.md +139 -0
  6. data/LICENSE.txt +21 -0
  7. data/README.md +622 -0
  8. data/SECURITY.md +24 -0
  9. data/lib/shields/anchor_href_template.rb +11 -0
  10. data/lib/shields/api_template.rb +11 -0
  11. data/lib/shields/badge/activity/github_commits_since_latest_release.rb +51 -0
  12. data/lib/shields/badge/base.rb +90 -0
  13. data/lib/shields/badge/build/github_branch_check_runs.rb +40 -0
  14. data/lib/shields/badge/code_coverage/coveralls.rb +42 -0
  15. data/lib/shields/badge/downloads/gem_download_rank.rb +37 -0
  16. data/lib/shields/badge/downloads/gem_total_downloads.rb +32 -0
  17. data/lib/shields/badge/social/github_repo_stars.rb +30 -0
  18. data/lib/shields/badge/version.rb +9 -0
  19. data/lib/shields/badge.rb +156 -0
  20. data/lib/shields/categories.rb +17 -0
  21. data/lib/shields/errors/error.rb +5 -0
  22. data/lib/shields/errors/not_implemented.rb +5 -0
  23. data/lib/shields/errors/validation_error.rb +5 -0
  24. data/lib/shields/formatters/image_src_url.rb +17 -0
  25. data/lib/shields/formatters/markdown.rb +18 -0
  26. data/lib/shields/label_text_template.rb +11 -0
  27. data/lib/shields/plugins/git_branch_plugin.rb +17 -0
  28. data/lib/shields/plugins/github_repo_plugin.rb +18 -0
  29. data/lib/shields/plugins/path_plugin.rb +11 -0
  30. data/lib/shields/plugins/query_plugin.rb +51 -0
  31. data/lib/shields/register_all.rb +12 -0
  32. data/lib/shields/serializers/camel_caser.rb +37 -0
  33. data.tar.gz.sig +0 -0
  34. metadata +455 -0
  35. metadata.gz.sig +0 -0
data/README.md ADDED
@@ -0,0 +1,622 @@
1
+ <p align="center">
2
+ <a href="https://discord.gg/3qme4XHNKN" target="_blank" rel="noopener">
3
+ <img width="124px" src="https://github.com/galtzo-floss/shields-badge/raw/main/docs/images/logo/galtzo-floss-logos-original.svg?raw=true" alt="Galtzo.com Logo by Aboling0, CC BY-SA 4.0">
4
+ </a>
5
+ <a href="https://shields.io" target="_blank" rel="noopener">
6
+ <img width="124px" src="https://github.com/galtzo-floss/shields-badge/raw/main/docs/images/logo/shields-logo-200px.png?raw=true" alt="Galtzo.com Logo by Aboling0, CC BY-SA 4.0">
7
+ </a>
8
+ <a href="https://www.ruby-lang.org/" target="_blank" rel="noopener">
9
+ <img width="124px" src="https://github.com/galtzo-floss/shields-badge/raw/main/docs/images/logo/ruby-logo-198px.svg?raw=true" alt="Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5">
10
+ </a>
11
+ </p>
12
+
13
+ # 📛 Shields::Badge
14
+
15
+ [![Version][👽versioni]][👽version] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![Depfu][🔑depfui♻️]][🔑depfu] [![Coveralls Test Coverage][🔑coveralls-img]][🔑coveralls] [![QLTY Test Coverage][🔑qlty-covi♻️]][🔑qlty-cov] [![QLTY Maintainability][🔑qlty-mnti♻️]][🔑qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![CI Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Legacy][🚎4-lg-wfi]][🚎4-lg-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL]
16
+
17
+ ---
18
+
19
+ [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
20
+
21
+
22
+ RubyGem version of the interactive tool found at [shields.io/badges](https://shields.io/badges).
23
+
24
+ <p>
25
+ If you use this project, or badges from Shields.io, please help increase Shields.io's rate limit by
26
+ <a href="https://img.shields.io/github-auth" target="_blank" rel="noopener noreferrer">authorizing the Shields.io GitHub application</a>.
27
+ Read more about <a href="https://shields.io/blog/token-pool">how it works</a>.
28
+ </p>
29
+
30
+ | Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
31
+ |-------------------------------------------------------|-------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
32
+ | 🧪 [galtzo-floss/shields-badge on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜wiki] | 🏀 Tiny Matrix | ➖ |
33
+ | 🧊 [galtzo-floss/shields-badge on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | ➖ | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
34
+ | 🐙 [galtzo-floss/shields-badge on GitHub][📜src-gh] | A Dirty Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | ➖ | 💯 Full Matrix | ➖ |
35
+ | 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
36
+
37
+ ### Upgrading Runtime Gem Dependencies
38
+
39
+ Great care has been taken to ensure this gem is working with all the
40
+ leading versions per each minor version of Ruby of all the runtime dependencies it can install with.
41
+
42
+ What does that mean specifically for the runtime dependencies?
43
+
44
+ We are approaching 100% test coverage of lines and branches, and this test suite runs across a large matrix
45
+ covering the latest patch for each of the following minor versions:
46
+
47
+ * MRI Ruby @ v3.1, v3.2, v3.3, v3.4, HEAD
48
+ * JRuby @ v9.4, v10.0, HEAD
49
+ * TruffleRuby @ v24.1, HEAD
50
+ * gem `castkit` @ v0, HEAD ⏩️ [bnlucas/castkit](https://github.com/bnlucas/castkit)
51
+ * gem `version_gem` @ v1, HEAD ⏩️ [oauth-xx/version_gem](https://gitlab.com/oauth-xx/version_gem)
52
+
53
+ #### You should upgrade this gem with confidence\*.
54
+
55
+ - This gem follows a _strict & correct_ (according to the maintainer of SemVer; [more info][sv-pub-api]) interpretation of SemVer.
56
+ - Dropping support for **any** of the runtime dependency _versions_ above will be a major version bump.
57
+ - If you aren't on one of the minor versions above, make getting there a priority.
58
+ - You should upgrade the dependencies of this gem with confidence\*.
59
+ - Please do upgrade, and then, when it goes smooth as butter [please sponsor me][🖇sponsor]. Thanks!
60
+
61
+ [sv-pub-api]: #-is-platform-support-part-of-the-public-api
62
+
63
+ \* MIT license; I am unable to make guarantees.
64
+
65
+ | 🚚 Test matrix brought to you by | 🔎 appraisal++ |
66
+ |----------------------------------|-------------------------------------------------------------------------|
67
+ | Adds back support for old Rubies | ✨ [appraisal PR #250](https://github.com/thoughtbot/appraisal/pull/250) |
68
+ | Adds support for `eval_gemfile` | ✨ [appraisal PR #248](https://github.com/thoughtbot/appraisal/pull/248) |
69
+ | Please review | my PRs! |
70
+
71
+ <details>
72
+ <summary>Standard Library Dependencies</summary>
73
+
74
+ The various versions are tested within whatever Ruby includes them, via the Ruby test matrix.
75
+
76
+ * uri
77
+
78
+ If you use a discrete gem version it should also work fine!
79
+
80
+ </details>
81
+
82
+ ### Quick Usage Example for AI and Copy / Pasting
83
+
84
+ Do you ever lay awake at night thinking?
85
+
86
+ - How is the CI looking for `kettle-soup-cover`? [![kettle-rb/kettle-soup-cover check runs (branch: main)](https://img.shields.io/github/check-runs/kettle-rb/kettle-soup-cover/main?)](https://github.com/kettle-rb/kettle-soup-cover/actions)
87
+ - What is the current coverage on `oauth2` gem? [![oauth-xx/oauth2 test coverage](https://img.shields.io/coverallsCoverage/github/oauth-xx/oauth2?)](https://github.com/oauth-xx/oauth2/actions)
88
+ - How many commits have there been since last release of `gem_bench`? [![pboling/gem_bench commits since latest release](https://img.shields.io/github/commits-since/pboling/gem_bench/latest?)](https://github.com/pboling/gem_bench/releases)
89
+ - What is the download rank (all time) for `anonymous_active_record`? [![RubyGems Download Rank](https://img.shields.io/gem/rt/anonymous_active_record?)](https://rubygems.org/gems/anonymous_active_record)
90
+ - What is the download rank (today) for `sanitize_email`? [![RubyGems Download Rank](https://img.shields.io/gem/rd/sanitize_email?)](https://rubygems.org/gems/sanitize_email)
91
+ - What are the total downloads of `rubocop-lts`? [![RubyGems Total Downloads](https://img.shields.io/gem/dt/rubocop-lts?)](https://rubygems.org/gems/rubocop-lts)
92
+ - How many stars does `flag_shih_tzu` have? [![GitHub Stars](https://img.shields.io/github/stars/pboling/flag_shih_tzu?)](https:///github.com/pboling/flag_shih_tzu/stargazers)
93
+
94
+ Or maybe you want to build a dashboard of badges for all your projects...
95
+
96
+ For the badges that have been implemented, all options on Shields.io are available.
97
+
98
+ ```ruby
99
+ # Optional: Eager load all badges (otherwise they will load the first time called through method_missing)
100
+ Shields::Badge.register_all
101
+
102
+ # All Path Parameters are supported
103
+ Shields::Badge.github_branch_check_runs(user: "kettle-rb", repo: "kettle-soup-cover", branch: "main")
104
+ # => "[![kettle-rb/kettle-soup-cover check runs (branch: main)](https://img.shields.io/github/check-runs/kettle-rb/kettle-soup-cover/main?)](https://github.com/kettle-rb/kettle-soup-cover/actions)"
105
+ Shields::Badge.coveralls(user: "oauth-xx", repo: "oauth2", vcs_type: "github")
106
+ # => "[![oauth-xx/oauth2 test coverage](https://img.shields.io/coverallsCoverage/github/oauth-xx/oauth2?)](https://github.com/oauth-xx/oauth2/actions)"
107
+ Shields::Badge.github_commits_since_latest_release(user: "pboling", repo: "gem_bench")
108
+ # => "[![pboling/gem_bench commits since latest release](https://img.shields.io/github/commits-since/pboling/gem_bench/latest?)](https://github.com/pboling/gem_bench/releases)"
109
+ Shields::Badge.gem_download_rank(period: "rt", gem: "anonymous_active_record")
110
+ # => "[![RubyGems Download Rank](https://img.shields.io/gem/rt/anonymous_active_record?)](https://rubygems.org/gems/anonymous_active_record)"
111
+ Shields::Badge.gem_download_rank(gem: "sanitize_email", period: "rd")
112
+ # => "[![RubyGems Download Rank](https://img.shields.io/gem/rd/sanitize_email?)](https://rubygems.org/gems/sanitize_email)"
113
+ Shields::Badge.gem_total_downloads(gem: "rubocop-lts")
114
+ # => "[![RubyGems Total Downloads](https://img.shields.io/gem/dt/rubocop-lts?)](https://rubygems.org/gems/rubocop-lts)"
115
+ Shields::Badge.github_repo_stars(user: "pboling", repo: "flag_shih_tzu")
116
+ # => "[![GitHub Stars](https://img.shields.io/github/stars/pboling/flag_shih_tzu?)](https:///github.com/pboling/flag_shih_tzu/stargazers)"
117
+
118
+ # All Query Parameters are supported; check Usage section below.
119
+ ```
120
+
121
+ ## 💡 Info you can shake a stick at
122
+
123
+ | Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
124
+ |-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
125
+ | Works with JRuby | [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎10-j-wf] [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
126
+ | Works with Truffle Ruby | [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] [![Truffle Ruby HEAD Compat][💎truby-headi]][🚎3-hd-wf] |
127
+ | Works with MRI Ruby 3 | [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎6-s-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
128
+ | Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
129
+ | Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![HEAD on RubyDoc.info][📜docs-head-rd-img]][🚎yard-head] [![BDFL Blog][🚂bdfl-blog-img]][🚂bdfl-blog] [![Wiki][📜wiki-img]][📜wiki] |
130
+ | Compliance | [![License: MIT][📄license-img]][📄license-ref] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
131
+ | Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] |
132
+ | Support | [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor] |
133
+ | Enterprise Support | [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]<br/>💡Subscribe for support guarantees covering _all_ FLOSS dependencies!<br/>💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]!<br/>💡Tidelift pays maintainers to maintain the software you depend on!<br/>📊`@`Pointy Haired Boss: An [enterprise support][🏙️entsup-tidelift] subscription is "[never gonna let you down][🧮kloc]", and *supports* open source maintainers! |
134
+ | Comrade BDFL 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact BDFL][🚂bdfl-contact-img]][🚂bdfl-contact] [![My technical writing][💖💁🏼‍♂️devto-img]][💖💁🏼‍♂️devto] |
135
+ | `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼‍♂️aboutme-img]][💖💁🏼‍♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab] |
136
+
137
+ ## 🚀 Release Documentation
138
+
139
+ ### Version 1.0.x
140
+
141
+ <details>
142
+ <summary>1.0.x CHANGELOGs and READMEs</summary>
143
+
144
+ | Version | Release Date | CHANGELOG | README |
145
+ |---------|--------------|-------------------------------------|-------------------------------|
146
+ | 1.0.0 | 2025-05-29 | [v1.0.0 CHANGELOG][1.0.0-changelog] | [v1.0.0 README][1.0.0-readme] |
147
+ </details>
148
+
149
+ [1.0.0-changelog]: https://gitlab.com/galtzo-floss/shields-badge/-/blob/main/CHANGELOG.md?ref_type=heads#100---2025-05-29
150
+
151
+ [1.0.0-readme]: https://gitlab.com/galtzo-floss/shields-badge/-/blob/v1.0.0/README.md
152
+
153
+ ## ✨ Installation
154
+
155
+ Install the gem and add to the application's Gemfile by executing:
156
+
157
+ $ bundle add shields-badge
158
+
159
+ If bundler is not being used to manage dependencies, install the gem by executing:
160
+
161
+ $ gem install shields-badge
162
+
163
+ ### 🔒 Secure Installation
164
+
165
+ `shields-badge` is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
166
+ [stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
167
+ by following the instructions below.
168
+
169
+ Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
170
+
171
+ ```shell
172
+ gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/shields-badge/main/certs/pboling.pem)
173
+ ```
174
+
175
+ You only need to do that once. Then proceed to install with:
176
+
177
+ ```shell
178
+ gem install shields-badge -P MediumSecurity
179
+ ```
180
+
181
+ The `MediumSecurity` trust profile will verify signed gems, but allow the installation of unsigned dependencies.
182
+
183
+ This is necessary because not all of `shields-badge`’s dependencies are signed, so we cannot use `HighSecurity`.
184
+
185
+ If you want to up your security game full-time:
186
+
187
+ ```shell
188
+ bundle config set --global trust-policy MediumSecurity
189
+ ```
190
+
191
+ NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
192
+
193
+ ## Shields::Badge for Enterprise
194
+
195
+ Available as part of the Tidelift Subscription.
196
+
197
+ The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.][tidelift-ref]
198
+
199
+ [tidelift-ref]: https://tidelift.com/subscription/pkg/rubygems-shields-badge?utm_source=rubygems-shields-badge&utm_medium=referral&utm_campaign=enterprise
200
+
201
+ ## Security contact information
202
+
203
+ To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
204
+ Tidelift will coordinate the fix and disclosure.
205
+
206
+ For more see [SECURITY.md][🔐security].
207
+
208
+ ## Compatibility
209
+
210
+ Targeted ruby compatibility is non-EOL versions of Ruby, currently 3.2, 3.3, and 3.4.
211
+ Compatibility is further distinguished as "Best Effort Support" or "Incidental Support" for older versions of Ruby.
212
+ This gem will install on Ruby versions >= v3.1 for 1.x releases.
213
+
214
+ <details>
215
+ <summary>Ruby Engine Compatibility Policy</summary>
216
+
217
+ This gem is tested against MRI, JRuby, and Truffleruby.
218
+ Each of those has varying versions that target a specific version of MRI Ruby.
219
+ This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility of each version, though there are exceptions for certain things.
220
+ </details>
221
+
222
+ <details>
223
+ <summary>Ruby Version Compatibility Policy</summary>
224
+
225
+ If something doesn't work on one of the supported versions, it's a bug.
226
+ </details>
227
+
228
+ | | Ruby Shields::Badge Version | Maintenance Branch | Targeted Support | Best Effort Support | Incidental Support |
229
+ |:----|-----------------------------|--------------------|------------------|---------------------|--------------------|
230
+ | 1️⃣ | 1.0.x | `main` | 3.2, 3.3, 3.4 | 3.1 | N/A |
231
+
232
+ NOTE: The 1.4 series will only receive critical security updates.
233
+ See [SECURITY.md][🔐security].
234
+
235
+ ## 🔧 Basic Usage
236
+
237
+ All parameters are in snake case when passing as Ruby arguments.
238
+ Certain parameters are configured to serialize as camel case (lower first) when formatted.
239
+ This is all automatic, and you don't need to worry about it.
240
+ You can even supply the parameters in camel case (lower first) if you want.
241
+
242
+ ### Setup
243
+
244
+ Require the library (if this gem is in your `Gemfile` bundler will do this for you):
245
+
246
+ ```ruby
247
+ require "shields/badge"
248
+ ```
249
+
250
+ #### Prefer method_missing or eager load?
251
+
252
+ The first time they are invoked, the badge generation methods on `Shields::Badge` will automatically require the badge tooling they need to generate a badge. If you want to avoid `method_missing`, you can eager load all the badges with `Shields::Badge.register_all`.
253
+
254
+ ### Path Parameters
255
+
256
+ These are generally required arguments and vary from badge to badge.
257
+
258
+ See the specs for examples. There is a spec for every badge, and at least one spec that utilizes every available path parameter.
259
+
260
+ ### Query Parameters
261
+
262
+ Most of these are optional arguments, but the odd one is required.
263
+
264
+ The query parameters that all badges share are:
265
+
266
+ ```ruby
267
+ path_parameters = {gem: "orange"}
268
+ query_parameters = {
269
+ style: "flat",
270
+ logo: "github",
271
+ logo_color: "yellow",
272
+ logo_size: "auto",
273
+ label: "banana",
274
+ label_color: "blue",
275
+ color: "black",
276
+ cache_seconds: "3600",
277
+ link: "https://example.com/green/red",
278
+ }
279
+ # NOTE: You can specify path and query parameters separately, or as top-level arguments.
280
+ Shields::Badge.gem_total_downloads(path_parameters:, query_parameters:)
281
+ # => "[![RubyGems Total Downloads](https://img.shields.io/gem/dt/orange?style=flat&logo=github&logoColor=yellow&logoSize=auto&label=banana&labelColor=blue&color=black&cacheSeconds=3600&link=https%3A%2F%2Fexample.com%2Fgreen%2Fred)](https://rubygems.org/gems/orange)
282
+ Shields::Badge.gem_total_downloads(**path_parameters, **query_parameters)
283
+ # => "[![RubyGems Total Downloads](https://img.shields.io/gem/dt/orange?style=flat&logo=github&logoColor=yellow&logoSize=auto&label=banana&labelColor=blue&color=black&cacheSeconds=3600&link=https%3A%2F%2Fexample.com%2Fgreen%2Fred)](https://rubygems.org/gems/orange)
284
+ ```
285
+
286
+ All the optional values supported by Shields.io are supported. Some badges have additional query parameters.
287
+
288
+ For the arguments that are designated as camel case (lower first) on Shields.io, it doesn't matter if you supply the arguments in camel case (lower first) or snake case, as they will both work.
289
+
290
+ The above snake case arguments result in the same badge as the below camel case arguments:
291
+
292
+ ```ruby
293
+ path_parameters = {gem: "orange"}
294
+ query_parameters = {
295
+ style: "flat",
296
+ logo: "github",
297
+ logoColor: "yellow",
298
+ logoSize: "auto",
299
+ label: "banana",
300
+ labelColor: "blue",
301
+ color: "black",
302
+ cacheSeconds: "3600",
303
+ link: "https://example.com/green/red",
304
+ }
305
+ Shields::Badge.gem_total_downloads(path_parameters:, query_parameters:)
306
+ # => "[![RubyGems Total Downloads](https://img.shields.io/gem/dt/orange?style=flat&logo=github&logoColor=yellow&logoSize=auto&label=banana&labelColor=blue&color=black&cacheSeconds=3600&link=https%3A%2F%2Fexample.com%2Fgreen%2Fred)](https://rubygems.org/gems/orange)
307
+
308
+ # And again it doesn't matter if the arguments are top-level or nested inside path and query parameters:
309
+ Shields::Badge.gem_total_downloads(**path_parameters, **query_parameters)
310
+ # => "[![RubyGems Total Downloads](https://img.shields.io/gem/dt/orange?style=flat&logo=github&logoColor=yellow&logoSize=auto&label=banana&labelColor=blue&color=black&cacheSeconds=3600&link=https%3A%2F%2Fexample.com%2Fgreen%2Fred)](https://rubygems.org/gems/orange)
311
+ ```
312
+
313
+ See the specs for more examples. There is a spec for every badge, and at least one spec that utilizes every available query parameter.
314
+
315
+ ### Formatters
316
+
317
+ Shields.io has 5 output formats. Of those, 2 have been implemented here, and PRs are welcome for the remainder.
318
+
319
+ | | URL | Markdown | rSt | AsciiDoc | HTML |
320
+ |-------------|---------------------------------|---------------------------|-----|----------|------|
321
+ | Implemented | 💚 | 💚 | ⏳️ | ⏳️ | ⏳️ |
322
+ | Module | `...::ImageSrcUrl` | `...::Markdown` | ⏳️ | ⏳️ | ⏳️ |
323
+ | Source | [image_src_url.rb][fmt-url-src] | [markdown.rb][fmt-md-src] | ⏳️ | ⏳️ | ⏳️ |
324
+
325
+ [fmt-url-src]: https://github.com/galtzo-floss/shields-badge/blob/main/lib/shields/formatter/image_src_url.rb
326
+ [fmt-md-src]: https://github.com/galtzo-floss/shields-badge/blob/main/lib/shields/formatter/markdown.rb
327
+
328
+ **Legend**
329
+
330
+ - `...` => `Shields::Formatters`
331
+ - `⏳️` => Please submit a Pull Request to implement this formatter
332
+
333
+ Check the sources of the two that are done. They are _very_ easy to write. This is a great project to get started with open source, because it is well tested, and patterned after the Shields.io website.
334
+
335
+ ## 🔐 Security
336
+
337
+ See [SECURITY.md][🔐security].
338
+
339
+ ## 🤝 Contributing
340
+
341
+ If you need some ideas of where to help, you could work on adding more code coverage,
342
+ or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
343
+ or use the gem and think about how it could be better.
344
+
345
+ We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
346
+
347
+ See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
348
+
349
+ ### 🚀 Release Instructions
350
+
351
+ See [CONTRIBUTING.md][🤝contributing].
352
+
353
+ ### Code Coverage
354
+
355
+ [![Coveralls Test Coverage][🔑coveralls-img]][🔑coveralls]
356
+ [![QLTY Test Coverage][🔑qlty-covi♻️]][🔑qlty-cov]
357
+
358
+ ### 🪇 Code of Conduct
359
+
360
+ Everyone interacting in this project's codebases, issue trackers,
361
+ chat rooms and mailing lists is expected to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
362
+
363
+ ## 🌈 Contributors
364
+
365
+ [![Contributors][🖐contributors-img]][🖐contributors]
366
+
367
+ Made with [contributors-img][🖐contrib-rocks].
368
+
369
+ Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/shields-badge/-/graphs/main][🚎contributors-gl]
370
+
371
+ ## ⭐️ Star History
372
+
373
+ <a href="https://star-history.com/#galtzo-floss/shields-badge&Date">
374
+ <picture>
375
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/shields-badge&type=Date&theme=dark" />
376
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=galtzo-floss/shields-badge&type=Date" />
377
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=galtzo-floss/shields-badge&type=Date" />
378
+ </picture>
379
+ </a>
380
+
381
+ ## 📌 Versioning
382
+
383
+ This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
384
+ Violations of this scheme should be reported as bugs.
385
+ Specifically, if a minor or patch version is released that breaks backward compatibility,
386
+ a new version should be immediately released that restores compatibility.
387
+ Breaking changes to the public API will only be introduced with new major versions.
388
+
389
+ ### 📌 Is "Platform Support" part of the public API?
390
+
391
+ Yes. But I'm obligated to include notes...
392
+
393
+ SemVer should, but doesn't explicitly, say that dropping support for specific Platforms
394
+ is a *breaking change* to an API.
395
+ It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.
396
+
397
+ > dropping support for a platform is both obviously and objectively a breaking change
398
+
399
+ - Jordan Harband (@ljharb, maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
400
+
401
+ To get a better understanding of how SemVer is intended to work over a project's lifetime,
402
+ read this article from the creator of SemVer:
403
+
404
+ - ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
405
+
406
+ As a result of this policy, and the interpretive lens used by the maintainer,
407
+ you can (and should) specify a dependency on these libraries using
408
+ the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
409
+
410
+ For example:
411
+
412
+ ```ruby
413
+ spec.add_dependency("shields-badge", "~> 1.0")
414
+ ```
415
+
416
+ See [CHANGELOG.md][📌changelog] for list of releases.
417
+
418
+ ## 📄 License
419
+
420
+ The gem is available as open source under the terms of
421
+ the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
422
+ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
423
+
424
+ ### © Copyright
425
+
426
+ <ul>
427
+ <li>
428
+ 2025 Peter H. Boling, of
429
+ <a href="https://discord.gg/3qme4XHNKN">
430
+ Galtzo.com
431
+ <picture>
432
+ <img src="https://github.com/galtzo-floss/shields-badge/raw/main/docs/images/logo/galtzo-floss-logos-wordless.svg?raw=true" alt="Galtzo.com Logo by Aboling0, CC BY-SA 4.0" height="20">
433
+ </picture>
434
+ </a>, and shields-badge contributors
435
+ </li>
436
+ </ul>
437
+
438
+ ## 🤑 One more thing
439
+
440
+ You made it to the bottom of the page,
441
+ so perhaps you'll indulge me for another 20 seconds.
442
+ I maintain many dozens of gems, including this one,
443
+ because I want Ruby to be a great place for people to solve problems, big and small.
444
+ Please consider supporting my efforts via the giant yellow link below,
445
+ or one of the others at the head of this README.
446
+
447
+ [![Buy me a latte][🖇buyme-img]][🖇buyme]
448
+
449
+ [✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
450
+ [⛳️gem-namespace]: https://github.com/galtzo-floss/shields-badge
451
+ [⛳️namespace-img]: https://img.shields.io/badge/namespace-Shields::Badge-brightgreen.svg?style=flat&logo=ruby&logoColor=white
452
+ [⛳️gem-name]: https://rubygems.org/gems/shields-badge
453
+ [⛳️name-img]: https://img.shields.io/badge/name-shields-badge-brightgreen.svg?style=flat&logo=rubygems&logoColor=red
454
+ [🚂bdfl-blog]: http://www.railsbling.com/tags/shields-badge
455
+ [🚂bdfl-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
456
+ [🚂bdfl-contact]: http://www.railsbling.com/contact
457
+ [🚂bdfl-contact-img]: https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
458
+ [💖🖇linkedin]: http://www.linkedin.com/in/peterboling
459
+ [💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
460
+ [💖✌️wellfound]: https://angel.co/u/peter-boling
461
+ [💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
462
+ [💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
463
+ [💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
464
+ [💖🐘ruby-mast]: https://ruby.social/@galtzo
465
+ [💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=flat&logo=mastodon&label=Ruby%20%40galtzo
466
+ [💖🦋bluesky]: https://bsky.app/profile/galtzo.com
467
+ [💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
468
+ [💖🌳linktree]: https://linktr.ee/galtzo
469
+ [💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
470
+ [💖💁🏼‍♂️devto]: https://dev.to/galtzo
471
+ [💖💁🏼‍♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
472
+ [💖💁🏼‍♂️aboutme]: https://about.me/peter.boling
473
+ [💖💁🏼‍♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
474
+ [💖🧊berg]: https://codeberg.org/pboling
475
+ [💖🐙hub]: https://github.org/pboling
476
+ [💖🛖hut]: https://sr.ht/~galtzo/
477
+ [💖🧪lab]: https://gitlab.com/pboling
478
+ [👨🏼‍🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
479
+ [👨🏼‍🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
480
+ [👨🏼‍🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
481
+ [👨🏼‍🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
482
+ [🏙️entsup-tidelift]: https://tidelift.com/subscription
483
+ [🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
484
+ [🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
485
+ [💁🏼‍♂️peterboling]: http://www.peterboling.com
486
+ [🚂railsbling]: http://www.railsbling.com
487
+ [📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
488
+ [📜src-gl]: https://gitlab.com/galtzo-floss/shields-badge/
489
+ [📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
490
+ [📜src-cb]: https://codeberg.org/galtzo-floss/shields-badge
491
+ [📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
492
+ [📜src-gh]: https://github.com/galtzo-floss/shields-badge
493
+ [📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
494
+ [📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
495
+ [📜wiki]: https://gitlab.com/galtzo-floss/shields-badge/-/wikis/home
496
+ [📜wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=Wiki&logoColor=white
497
+ [👽dl-rank]: https://rubygems.org/gems/shields-badge
498
+ [👽dl-ranki]: https://img.shields.io/gem/rd/shields-badge.svg
499
+ [👽oss-help]: https://www.codetriage.com/galtzo-floss/shields-badge
500
+ [👽oss-helpi]: https://www.codetriage.com/galtzo-floss/shields-badge/badges/users.svg
501
+ [👽version]: https://rubygems.org/gems/shields-badge
502
+ [👽versioni]: https://img.shields.io/gem/v/shields-badge.svg
503
+ [🔑qlty-mnt]: https://qlty.sh/gh/galtzo-floss/projects/shields-badge
504
+ [🔑qlty-mnti♻️]: https://qlty.sh/badges/35dfa7f0-ac27-4223-b35a-2b5561e495b5/maintainability.svg
505
+ [🔑qlty-cov]: https://qlty.sh/gh/galtzo-floss/projects/shields-badge
506
+ [🔑qlty-covi♻️]: https://qlty.sh/badges/35dfa7f0-ac27-4223-b35a-2b5561e495b5/test_coverage.svg
507
+ [🔑codecov]: https://codecov.io/gh/galtzo-floss/shields-badge
508
+ [🔑codecovi♻️]: https://codecov.io/gh/galtzo-floss/shields-badge/graph/badge.svg?token=bNqSzNiuo2
509
+ [🔑coveralls]: https://coveralls.io/github/galtzo-floss/shields-badge?branch=main
510
+ [🔑coveralls-img]: https://coveralls.io/repos/github/galtzo-floss/shields-badge/badge.svg?branch=main
511
+ [🔑depfu]: https://depfu.com/github/galtzo-floss/shields-badge?project_id=63700
512
+ [🔑depfui♻️]: https://badges.depfu.com/badges/e77d4201589e563af3c7bef975e5cd0b/count.svg
513
+ [🖐codeQL]: https://github.com/galtzo-floss/shields-badge/security/code-scanning
514
+ [🖐codeQL-img]: https://github.com/galtzo-floss/shields-badge/actions/workflows/codeql-analysis.yml/badge.svg
515
+ [🚎2-cov-wf]: https://github.com/galtzo-floss/shields-badge/actions/workflows/coverage.yml
516
+ [🚎2-cov-wfi]: https://github.com/galtzo-floss/shields-badge/actions/workflows/coverage.yml/badge.svg
517
+ [🚎3-hd-wf]: https://github.com/galtzo-floss/shields-badge/actions/workflows/heads.yml
518
+ [🚎3-hd-wfi]: https://github.com/galtzo-floss/shields-badge/actions/workflows/heads.yml/badge.svg
519
+ [🚎4-lg-wf]: https://github.com/galtzo-floss/shields-badge/actions/workflows/legacy.yml
520
+ [🚎4-lg-wfi]: https://github.com/galtzo-floss/shields-badge/actions/workflows/legacy.yml/badge.svg
521
+ [🚎5-st-wf]: https://github.com/galtzo-floss/shields-badge/actions/workflows/style.yml
522
+ [🚎5-st-wfi]: https://github.com/galtzo-floss/shields-badge/actions/workflows/style.yml/badge.svg
523
+ [🚎6-s-wf]: https://github.com/galtzo-floss/shields-badge/actions/workflows/supported.yml
524
+ [🚎6-s-wfi]: https://github.com/galtzo-floss/shields-badge/actions/workflows/supported.yml/badge.svg
525
+ [🚎9-t-wf]: https://github.com/galtzo-floss/shields-badge/actions/workflows/truffle.yml
526
+ [🚎9-t-wfi]: https://github.com/galtzo-floss/shields-badge/actions/workflows/truffle.yml/badge.svg
527
+ [🚎10-j-wf]: https://github.com/galtzo-floss/shields-badge/actions/workflows/jruby.yml
528
+ [🚎10-j-wfi]: https://github.com/galtzo-floss/shields-badge/actions/workflows/jruby.yml/badge.svg
529
+ [🚎11-c-wf]: https://github.com/galtzo-floss/shields-badge/actions/workflows/current.yml
530
+ [🚎11-c-wfi]: https://github.com/galtzo-floss/shields-badge/actions/workflows/current.yml/badge.svg
531
+ [🚎12-crh-wf]: https://github.com/galtzo-floss/shields-badge/actions/workflows/current-runtime-heads.yml
532
+ [🚎12-crh-wfi]: https://github.com/galtzo-floss/shields-badge/actions/workflows/current-runtime-heads.yml/badge.svg
533
+ [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay
534
+ [⛳liberapay]: https://liberapay.com/pboling/donate
535
+ [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
536
+ [🖇sponsor]: https://github.com/sponsors/pboling
537
+ [🖇polar-img]: https://img.shields.io/badge/polar-donate-yellow.svg
538
+ [🖇polar]: https://polar.sh/pboling
539
+ [🖇kofi-img]: https://img.shields.io/badge/a_more_different_coffee-✓-yellow.svg
540
+ [🖇kofi]: https://ko-fi.com/O5O86SNP4
541
+ [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-yellow.svg
542
+ [🖇patreon]: https://patreon.com/galtzo
543
+ [🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
544
+ [🖇buyme]: https://www.buymeacoffee.com/pboling
545
+ [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-✓-yellow.svg?style=flat
546
+ [💎ruby-2.3i]: https://img.shields.io/badge/Ruby-2.3-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
547
+ [💎ruby-2.4i]: https://img.shields.io/badge/Ruby-2.4-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
548
+ [💎ruby-2.5i]: https://img.shields.io/badge/Ruby-2.5-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
549
+ [💎ruby-2.6i]: https://img.shields.io/badge/Ruby-2.6-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
550
+ [💎ruby-2.7i]: https://img.shields.io/badge/Ruby-2.7-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
551
+ [💎ruby-3.0i]: https://img.shields.io/badge/Ruby-3.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
552
+ [💎ruby-3.1i]: https://img.shields.io/badge/Ruby-3.1-CC342D?style=for-the-badge&logo=ruby&logoColor=white
553
+ [💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
554
+ [💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
555
+ [💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
556
+ [💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
557
+ [💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
558
+ [💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
559
+ [💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
560
+ [💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
561
+ [💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
562
+ [💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1-FBE742?style=for-the-badge&logo=ruby&logoColor=red
563
+ [💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2-FBE742?style=for-the-badge&logo=ruby&logoColor=red
564
+ [💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3-FBE742?style=for-the-badge&logo=ruby&logoColor=red
565
+ [💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
566
+ [💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
567
+ [💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
568
+ [🤝gh-issues]: https://github.com/galtzo-floss/shields-badge/issues
569
+ [🤝gh-pulls]: https://github.com/galtzo-floss/shields-badge/pulls
570
+ [🤝gl-issues]: https://gitlab.com/galtzo-floss/shields-badge/-/issues
571
+ [🤝gl-pulls]: https://gitlab.com/galtzo-floss/shields-badge/-/merge_requests
572
+ [🤝cb-issues]: https://codeberg.org/galtzo-floss/shields-badge/issues
573
+ [🤝cb-pulls]: https://codeberg.org/galtzo-floss/shields-badge/pulls
574
+ [🤝cb-donate]: https://donate.codeberg.org/
575
+ [🤝contributing]: CONTRIBUTING.md
576
+ [🔑codecov-g♻️]: https://codecov.io/gh/galtzo-floss/shields-badge/graphs/tree.svg?token=bNqSzNiuo2
577
+ [🖐contrib-rocks]: https://contrib.rocks
578
+ [🖐contributors]: https://github.com/galtzo-floss/shields-badge/graphs/contributors
579
+ [🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/shields-badge
580
+ [🚎contributors-gl]: https://gitlab.com/galtzo-floss/shields-badge/-/graphs/main
581
+ [🪇conduct]: CODE_OF_CONDUCT.md
582
+ [🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
583
+ [📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
584
+ [📌semver]: https://semver.org/spec/v2.0.0.html
585
+ [📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
586
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
587
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
588
+ [📌changelog]: CHANGELOG.md
589
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
590
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
591
+ [📌gitmoji]:https://gitmoji.dev
592
+ [📌gitmoji-img]:https://img.shields.io/badge/gitmoji_commits-%20😜%20😍-34495e.svg?style=flat-square
593
+ [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
594
+ [🧮kloc-img]: https://img.shields.io/badge/KLOC-0.362-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
595
+ [🔐security]: SECURITY.md
596
+ [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
597
+ [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
598
+ [📄license]: LICENSE.txt
599
+ [📄license-ref]: https://opensource.org/licenses/MIT
600
+ [📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
601
+ [📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
602
+ [📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
603
+ [🚎yard-current]: http://rubydoc.info/gems/shields-badge
604
+ [🚎yard-head]: https://shields-badge.galtzo.com
605
+ [💎stone_checksums]: https://github.com/pboling/stone_checksums
606
+ [💎SHA_checksums]: https://gitlab.com/galtzo-floss/shields-badge/-/tree/main/checksums
607
+ [💎rlts]: https://github.com/rubocop-lts/rubocop-lts
608
+ [💎rlts-img]: https://img.shields.io/badge/code_style_%26_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
609
+ [💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
610
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
611
+ [✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
612
+
613
+ <details>
614
+ <summary>Deprecated Badges</summary>
615
+
616
+ CodeCov currently fails to parse the coverage upload.
617
+
618
+ [![CodeCov Test Coverage][🔑codecovi♻️]][🔑codecov]
619
+
620
+ [![Coverage Graph][🔑codecov-g♻️]][🔑codecov]
621
+
622
+ </details>