kettle-jem 7.0.0 → 7.1.3

data/lib/kettle/jem/templates/README.md.example

@@ -0,0 +1,544 @@
+{KJ|README:TOP_LOGO_ROW}
+
+{KJ|README:TOP_LOGO_REFS}
+
+# {KJ|PROJECT_EMOJI} {KJ|README:TITLE}
+
+[![Version][👽versioni]][👽version] [![Ruby Users Forum][✉️ruby-forum-top-img]][✉️ruby-forum] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] {KJ|README:LICENSE_BADGE} [![Total downloads][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![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 Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] {KJ|README:LICENSE_EYE_WORKFLOW_BADGE} {KJ|README:FOSSA_BADGE}
+
+`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know on Discord][✉️discord-invite] or [RubyForum][✉️ruby-forum], as I may have missed the notification.
+
+---
+
+`if ci_badges.map(&:color).all? { it == "green"}` 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
+
+<!-- KJ:OPEN_COLLECTIVE:START -->
+[![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
+<!-- KJ:OPEN_COLLECTIVE:END -->
+<!-- KJ:NO_OPEN_COLLECTIVE:START -->
+[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
+<!-- KJ:NO_OPEN_COLLECTIVE:END -->
+{KJ|README:CORPORATE_SPONSORS}
+
+<details markdown="1">
+    <summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
+
+I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
+
+</details>
+
+## 🌻 Synopsis {KJ|README:H2_SYNOPSIS_LOGO_ROW}
+
+
+## 💡 Info you can shake a stick at
+
+| Tokens to Remember      | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace]                                                                                                                                                                                                                                                                          |
+|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Works with JRuby        | [![JRuby 9.1 Compat][💎jruby-9.1i]][🚎jruby-9.1-wf] [![JRuby 9.2 Compat][💎jruby-9.2i]][🚎jruby-9.2-wf] [![JRuby 9.3 Compat][💎jruby-9.3i]][🚎jruby-9.3-wf] <br/> [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎jruby-9.4-wf] [![JRuby 10.0 Compat][💎jruby-10.0i]][🚎jruby-10.0-wf] [![JRuby current Compat][💎jruby-c-i]][🚎10-j-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf]                                                                                                       |
+| Works with Truffle Ruby | [![Truffle Ruby 22.3 Compat][💎truby-22.3i]][🚎truby-22.3-wf] [![Truffle Ruby 23.0 Compat][💎truby-23.0i]][🚎truby-23.0-wf] [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎truby-23.1-wf] <br/> [![Truffle Ruby 24.2 Compat][💎truby-24.2i]][🚎truby-24.2-wf] [![Truffle Ruby 25.0 Compat][💎truby-25.0i]][🚎truby-25.0-wf] [![Truffle Ruby 33.0 Compat][💎truby-33.0i]][🚎truby-33.0-wf] [![Truffle Ruby current Compat][💎truby-c-i]][🚎9-t-wf] [![Truffle Ruby HEAD Compat][💎truby-headi]][🚎3-hd-wf]                                                                                                                 |
+| Works with MRI Ruby 4   | [![Ruby current Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf]                                                                                                                                                                                                                  |
+| Works with MRI Ruby 3   | [![Ruby 3.0 Compat][💎ruby-3.0i]][🚎ruby-3.0-wf] [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎ruby-3.1-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎ruby-3.2-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎ruby-3.3-wf] [![Ruby 3.4 Compat][💎ruby-3.4i]][🚎ruby-3.4-wf]                                                                                                            |
+| Works with MRI Ruby 2   | ![Ruby 2.0 Compat][💎ruby-2.0i] ![Ruby 2.1 Compat][💎ruby-2.1i] ![Ruby 2.2 Compat][💎ruby-2.2i] ![Ruby 2.3 Compat][💎ruby-2.3i] <br/> [![Ruby 2.4 Compat][💎ruby-2.4i]][🚎ruby-2.4-wf] [![Ruby 2.5 Compat][💎ruby-2.5i]][🚎ruby-2.5-wf] [![Ruby 2.6 Compat][💎ruby-2.6i]][🚎ruby-2.6-wf] [![Ruby 2.7 Compat][💎ruby-2.7i]][🚎ruby-2.7-wf]                              |
+| Works with MRI Ruby 1   | ![Ruby 1.8 Compat][💎ruby-1.8i] ![Ruby 1.9 Compat][💎ruby-1.9i]                                                                                                                                                                                                                                                                                                     |
+| Support & Community     | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Get help from RubyForum][✉️ruby-forum-img]][✉️ruby-forum] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor]                                       |
+| 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]                                                                                                                                                         |
+| Documentation           | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki]                                                                                          |
+| Compliance              | {KJ|README:LICENSE_BADGE} {KJ|README:LICENSE_COMPAT_BADGE} [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
+| Style                   | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2]                                                                                                                  |
+| Maintainer 🎖️          | [![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 Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼‍♂️devto-img]][💖💁🏼‍♂️devto]                                                      |
+| `...` 💖                | [![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]                                                                   |
+
+### Compatibility
+
+Compatible with MRI Ruby {KJ|MIN_RUBY}+, and concordant releases of JRuby, and TruffleRuby.
+CI workflows and Appraisals are generated for MRI Ruby {KJ|MIN_TEST_RUBY}+.
+This test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml` and
+may be higher than the gem's runtime compatibility floor when legacy Rubies are
+not practical for the current toolchain.
+
+<a href="https://github.com/kettle-dev"><img alt="kettle-dev Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/kettle-dev/avatar-128px.svg" width="14%" align="right"/></a>
+
+The _amazing_ test matrix is powered by the kettle-dev stack.
+
+{KJ|README:DEV_TEST_STACK_TABLE}
+
+{KJ|README:FAMILY_INTRO_BACKEND_MATRIX}
+
+### Federated DVCS
+
+<details markdown="1">
+  <summary>Find this repo on federated forges (Coming soon!)</summary>
+
+| Federated [DVCS][💎d-in-dvcs] Repository        | Status                                    | Issues            | PRs              | Wiki            | CI             |
+|-------------------------------------------------|-------------------------------------------|-------------------|------------------|-----------------|----------------|
+| 🧪 [{KJ|README:REPO_SLUG} on GitLab][📜src-gl]   | The Truth                                 | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix |
+| 🧊 [{KJ|README:REPO_SLUG} on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖               | ⭕️ No Matrix   |
+| 🐙 [{KJ|README:REPO_SLUG} on GitHub][📜src-gh]   | Another Mirror                            | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix |
+
+</details>
+
+### Enterprise Support [![Tidelift](https://tidelift.com/badges/package/rubygems/{KJ|GEM_NAME})](https://tidelift.com/subscription/pkg/rubygems-{KJ|GEM_NAME}?utm_source=rubygems-{KJ|GEM_NAME}&utm_medium=referral&utm_campaign=readme)
+
+Available as part of the Tidelift Subscription.
+
+<details markdown="1">
+  <summary>Need enterprise-level guarantees?</summary>
+
+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.
+
+[![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
+
+- 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
+- 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
+- 💡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
+
+Alternatively:
+
+- [![Ruby Users Forum][✉️ruby-forum-img]][✉️ruby-forum]
+- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
+- [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork]
+- [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor]
+
+</details>
+
+## ✨ Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```console
+bundle add {KJ|GEM_NAME}
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```console
+gem install {KJ|GEM_NAME}
+```
+
+## ⚙️ Configuration
+
+
+## 🔧 Basic Usage
+
+
+## 🦷 FLOSS Funding
+
+While {KJ|GH_ORG} tools are free software and will always be, the project would benefit immensely from some funding.
+Raising a monthly budget of... "dollars" would make the project more sustainable.
+
+We welcome both individual and corporate sponsors! We also offer a
+wide array of funding channels to account for your preferences.
+<!-- KJ:OPEN_COLLECTIVE:START -->
+Currently, [Open Collective][🖇osc] is our preferred funding platform.
+<!-- KJ:OPEN_COLLECTIVE:END -->
+<!-- KJ:NO_OPEN_COLLECTIVE:START -->
+Currently, [GitHub Sponsors][🖇sponsor], and [Liberapay][⛳liberapay] are our preferred funding platforms.
+<!-- KJ:NO_OPEN_COLLECTIVE:END -->
+
+**If you're working in a company that's making significant use of {KJ|GH_ORG} tools we'd
+appreciate it if you suggest to your company to become a {KJ|GH_ORG} sponsor.**
+
+You can support the development of {KJ|GH_ORG} tools via
+[GitHub Sponsors][🖇sponsor],
+[Liberapay][⛳liberapay],
+[PayPal][🖇paypal],
+<!-- KJ:OPEN_COLLECTIVE:START -->
+[Open Collective][🖇osc]
+<!-- KJ:OPEN_COLLECTIVE:END -->
+and [Tidelift][🏙️entsup-tidelift].
+
+| 📍 NOTE                                                                                                                                                                                                              |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
+
+<!-- KJ:OPEN_COLLECTIVE:START -->
+### Open Collective for Individuals
+
+Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/{KJ|OPENCOLLECTIVE_ORG}#backer)]
+
+NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
+
+<!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
+No backers yet. Be the first!
+<!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
+
+### Open Collective for Organizations
+
+Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/{KJ|OPENCOLLECTIVE_ORG}#sponsor)]
+
+NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
+
+<!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
+No sponsors yet. Be the first!
+<!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
+
+[kettle-readme-backers]: {KJ|README:GH_REPOSITORY_URL}/blob/main/bin/kettle-readme-backers
+<!-- KJ:OPEN_COLLECTIVE:END -->
+
+### Another way to support open-source
+
+I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small.  Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions.  I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
+
+If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
+
+I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
+
+**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
+
+[![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
+
+## 🔐 Security
+
+See [SECURITY.md][🔐security].
+
+## 🤝 Contributing
+
+If you need some ideas of where to help, you could work on adding more code coverage,
+check [issues][🤝gh-issues] or [PRs][🤝gh-pulls], or use the gem and think about how it could be better.
+
+We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
+
+See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
+
+### 🚀 Release Instructions
+
+See [CONTRIBUTING.md][🤝contributing].
+
+### Code Coverage
+
+<details markdown="1">
+<summary>Coverage service badges</summary>
+
+[![Coverage Graph][🏀codecov-g]][🏀codecov]
+
+[![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
+
+[![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
+
+</details>
+
+### 🪇 Code of Conduct
+
+Everyone interacting with this project's codebases, issue trackers,
+chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
+
+## 🌈 Contributors
+
+[![Contributors][🖐contributors-img]][🖐contributors]
+
+Made with [contributors-img][🖐contrib-rocks].
+
+Also see GitLab Contributors: [{KJ|README:GL_CONTRIBUTORS_URL}][🚎contributors-gl]
+
+<details markdown="1">
+    <summary>⭐️ Star History</summary>
+
+<a href="https://star-history.dera.page/#{KJ|README:STAR_HISTORY_REPO}&type=date&legend=top-left">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://star-history.dera.page/svg?repos={KJ|README:STAR_HISTORY_REPO}&type=date&theme=dark&legend=top-left" />
+   <source media="(prefers-color-scheme: light)" srcset="https://star-history.dera.page/svg?repos={KJ|README:STAR_HISTORY_REPO}&type=date&legend=top-left" />
+   <img alt="Star History Chart" src="https://star-history.dera.page/svg?repos={KJ|README:STAR_HISTORY_REPO}&type=date&legend=top-left" />
+ </picture>
+</a>
+
+</details>
+
+## 📌 Versioning
+
+This library follows [![Semantic Versioning 2.0.0][📌semver-img]][📌semver] for its public API where practical.
+For most applications, prefer the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
+
+For example:
+
+```ruby
+spec.add_dependency("{KJ|GEM_NAME}", "~> {KJ|GEM_MAJOR}.0")
+```
+
+<details markdown="1">
+<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
+
+Dropping support for a platform can be a breaking change for affected users.
+If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
+
+To get a better understanding of how SemVer is intended to work over a project's lifetime,
+read this article from the creator of SemVer:
+
+- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
+
+</details>
+
+See [CHANGELOG.md][📌changelog] for a list of releases.
+
+## 📄 License
+
+{KJ|README:LICENSE_INTRO}
+
+### © Copyright
+
+{KJ|README:COPYRIGHT_NOTICE}
+
+## 🤑 A request for help
+
+Maintainers have teeth and need to pay their dentists.
+After getting laid off in an RIF in March, and encountering difficulty finding a new one,
+I began spending most of my time building open source tools.
+I'm hoping to be able to pay for my kids' health insurance this month,
+so if you value the work I am doing, I need your support.
+Please consider sponsoring me or the project.
+
+To join the community or get help, use the RubyForum or Discord.
+
+[![Ruby Users Forum][✉️ruby-forum-img]][✉️ruby-forum]
+[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
+
+To say "thanks!" ☝️ Join the community or 👇️ send money.
+
+<!-- KJ:OPEN_COLLECTIVE:START -->
+[![Sponsor {KJ|OPENCOLLECTIVE_ORG}/{KJ|GEM_NAME} on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
+<!-- KJ:OPEN_COLLECTIVE:END -->
+<!-- KJ:NO_OPEN_COLLECTIVE:START -->
+[![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
+<!-- KJ:NO_OPEN_COLLECTIVE:END -->
+
+### Please give the project a star ⭐ ♥.
+
+Many parts of this project are actively managed by a [kettle-jem](https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/kettle-jem) smart template utilizing [StructuredMerge.org](https://structuredmerge.org) merge contracts.
+
+Thanks for RTFM. ☺️
+
+[⛳liberapay-img]: https://img.shields.io/liberapay/goal/{KJ|FUNDING:LIBERAPAY}.svg?logo=liberapay&color=a51611&style=flat
+[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/{KJ|FUNDING:LIBERAPAY}.svg?style=for-the-badge&logo=liberapay&color=a51611
+[⛳liberapay]: https://liberapay.com/{KJ|FUNDING:LIBERAPAY}/donate
+<!-- KJ:OPEN_COLLECTIVE:START -->
+[🖇osc-all-img]: https://img.shields.io/opencollective/all/{KJ|OPENCOLLECTIVE_ORG}
+[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/{KJ|OPENCOLLECTIVE_ORG}
+[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/{KJ|OPENCOLLECTIVE_ORG}
+[🖇osc-backers]: https://opencollective.com/{KJ|OPENCOLLECTIVE_ORG}#backer
+[🖇osc-backers-i]: https://opencollective.com/{KJ|OPENCOLLECTIVE_ORG}/backers/badge.svg?style=flat
+[🖇osc-sponsors]: https://opencollective.com/{KJ|OPENCOLLECTIVE_ORG}#sponsor
+[🖇osc-sponsors-i]: https://opencollective.com/{KJ|OPENCOLLECTIVE_ORG}/sponsors/badge.svg?style=flat
+[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/{KJ|OPENCOLLECTIVE_ORG}?style=for-the-badge
+[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/{KJ|OPENCOLLECTIVE_ORG}?style=for-the-badge
+[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/{KJ|OPENCOLLECTIVE_ORG}?style=for-the-badge
+[🖇osc]: https://opencollective.com/{KJ|OPENCOLLECTIVE_ORG}
+<!-- KJ:OPEN_COLLECTIVE:END -->
+[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-{KJ|GH:USER}.svg?style=social&logo=github
+[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-{KJ|GH:USER}-blue?style=for-the-badge&logo=github
+[🖇sponsor]: https://github.com/sponsors/{KJ|GH:USER}
+[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
+[🖇kofi]: https://ko-fi.com/{KJ|FUNDING:KOFI}
+[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
+[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug={KJ|FUNDING:BUYMEACOFFEE}&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
+[🖇buyme]: https://www.buymeacoffee.com/{KJ|FUNDING:BUYMEACOFFEE}
+[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
+[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
+[🖇paypal]: https://www.paypal.com/paypalme/{KJ|FUNDING:PAYPAL}
+[🖇floss-funding.dev]: https://floss-funding.dev
+[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
+[✉️discord-invite]: https://discord.gg/3qme4XHNKN
+[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
+[✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
+[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
+[✉️ruby-forum-top-img]: {KJ|RUBYFORUM:BADGE_IMG}
+[✉️ruby-forum-img]: {KJ|RUBYFORUM:BADGE_IMG_FTB}
+[✉️ruby-forum]: {KJ|RUBYFORUM:URL}
+
+[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
+[⛳️gem-namespace]: {KJ|README:GH_PACKAGE_SOURCE_URL}
+[⛳️namespace-img]: https://img.shields.io/badge/namespace-{KJ|NAMESPACE_SHIELD}-3C2D2D.svg?style=square&logo=ruby&logoColor=white
+[⛳️gem-name]: https://clickgems.clickhouse.com/dashboard/{KJ|GEM_NAME}
+[⛳️name-img]: https://img.shields.io/badge/name-{KJ|GEM_SHIELD}-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
+[⛳️tag-img]: https://img.shields.io/github/tag/{KJ|README:GH_TAG_BADGE_REPO}.svg
+[⛳️tag]: {KJ|README:GH_RELEASES_URL}
+[🚂maint-blog]: http://www.railsbling.com/tags/{KJ|GEM_NAME}
+[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
+[🚂maint-contact]: http://www.railsbling.com/contact
+[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
+[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
+[💖🖇linkedin-img]: https://img.shields.io/badge/LinkedIn-Profile-0B66C2?style=flat&logo=newjapanprowrestling
+[💖✌️wellfound]: https://wellfound.com/u/peter-boling
+[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
+[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
+[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
+[💖🐘ruby-mast]: https://ruby.social/@{KJ|SOCIAL:MASTODON}
+[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@{KJ|SOCIAL:MASTODON}
+[💖🦋bluesky]: https://bsky.app/profile/{KJ|SOCIAL:BLUESKY}
+[💖🦋bluesky-img]: https://img.shields.io/badge/@{KJ|SOCIAL:BLUESKY}-0285FF?style=flat&logo=bluesky&logoColor=white
+[💖🌳linktree]: https://linktr.ee/{KJ|SOCIAL:LINKTREE}
+[💖🌳linktree-img]: https://img.shields.io/badge/{KJ|SOCIAL:LINKTREE}-purple?style=flat&logo=linktree
+[💖💁🏼‍♂️devto]: https://dev.to/{KJ|SOCIAL:DEVTO}
+[💖💁🏼‍♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
+[💖💁🏼‍♂️aboutme]: https://about.me/peter.boling
+[💖💁🏼‍♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
+[💖🧊berg]: https://codeberg.org/{KJ|CB:USER}
+[💖🐙hub]: https://github.org/{KJ|GH:USER}
+[💖🛖hut]: https://sr.ht/~{KJ|SH:USER}/
+[💖🧪lab]: https://gitlab.com/{KJ|GL:USER}
+[👨🏼‍🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
+[👨🏼‍🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
+[👨🏼‍🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
+[👨🏼‍🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
+[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-{KJ|GEM_NAME}?utm_source=rubygems-{KJ|GEM_NAME}&utm_medium=referral&utm_campaign=readme
+[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
+[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
+[💁🏼‍♂️peterboling]: http://www.peterboling.com
+[🚂railsbling]: http://www.railsbling.com
+[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
+[📜src-gl]: {KJ|README:GL_PACKAGE_SOURCE_URL}
+[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
+[📜src-cb]: {KJ|README:CB_PACKAGE_SOURCE_URL}
+[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=GitHub&logoColor=green
+[📜src-gh]: {KJ|README:GH_PACKAGE_SOURCE_URL}
+[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
+[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
+[📜gl-wiki]: {KJ|README:GL_WIKI_URL}
+[📜gh-wiki]: {KJ|README:GH_WIKI_URL}
+[📜gl-wiki-img]: https://img.shields.io/badge/wiki-gitlab-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
+[📜gh-wiki-img]: https://img.shields.io/badge/wiki-github-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
+[👽dl-rank]: https://clickgems.clickhouse.com/dashboard/{KJ|GEM_NAME}
+[👽dl-ranki]: https://img.shields.io/gem/dt/{KJ|GEM_NAME}.svg
+[👽version]: https://clickgems.clickhouse.com/dashboard/{KJ|GEM_NAME}
+[👽versioni]: https://img.shields.io/gem/v/{KJ|GEM_NAME}.svg
+[🏀qlty-mnt]: {KJ|README:QLTY_PROJECT_URL}
+[🏀qlty-mnti]: {KJ|README:QLTY_MAINTAINABILITY_URL}
+[🏀qlty-cov]: {KJ|README:QLTY_COVERAGE_URL}
+[🏀qlty-covi]: {KJ|README:QLTY_COVERAGE_BADGE_URL}
+[🏀codecov]: {KJ|README:CODECOV_URL}
+[🏀codecovi]: {KJ|README:CODECOV_BADGE_URL}
+[🏀coveralls]: {KJ|README:COVERALLS_URL}
+[🏀coveralls-img]: {KJ|README:COVERALLS_BADGE_URL}
+[🚎ruby-2.4-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-2.4.yml
+[🚎ruby-2.4-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-2.4.yml/badge.svg
+[🚎ruby-2.5-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-2.5.yml
+[🚎ruby-2.5-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-2.5.yml/badge.svg
+[🚎ruby-2.6-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-2.6.yml
+[🚎ruby-2.6-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-2.6.yml/badge.svg
+[🚎ruby-2.7-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-2.7.yml
+[🚎ruby-2.7-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-2.7.yml/badge.svg
+[🚎ruby-3.0-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.0.yml
+[🚎ruby-3.0-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.0.yml/badge.svg
+[🚎ruby-3.1-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.1.yml
+[🚎ruby-3.1-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.1.yml/badge.svg
+[🚎ruby-3.2-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.2.yml
+[🚎ruby-3.2-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.2.yml/badge.svg
+[🚎ruby-3.3-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.3.yml
+[🚎ruby-3.3-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.3.yml/badge.svg
+[🚎ruby-3.4-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.4.yml
+[🚎ruby-3.4-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/ruby-3.4.yml/badge.svg
+[🚎jruby-9.1-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-9.1.yml
+[🚎jruby-9.1-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-9.1.yml/badge.svg
+[🚎jruby-9.2-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-9.2.yml
+[🚎jruby-9.2-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-9.2.yml/badge.svg
+[🚎jruby-9.3-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-9.3.yml
+[🚎jruby-9.3-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-9.3.yml/badge.svg
+[🚎jruby-9.4-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-9.4.yml
+[🚎jruby-9.4-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-9.4.yml/badge.svg
+[🚎jruby-10.0-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-10.0.yml
+[🚎jruby-10.0-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby-10.0.yml/badge.svg
+[🚎truby-22.3-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-22.3.yml
+[🚎truby-22.3-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-22.3.yml/badge.svg
+[🚎truby-23.0-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-23.0.yml
+[🚎truby-23.0-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-23.0.yml/badge.svg
+[🚎truby-23.1-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-23.1.yml
+[🚎truby-23.1-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-23.1.yml/badge.svg
+[🚎truby-24.2-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-24.2.yml
+[🚎truby-24.2-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-24.2.yml/badge.svg
+[🚎truby-25.0-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-25.0.yml
+[🚎truby-25.0-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-25.0.yml/badge.svg
+[🚎truby-33.0-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-33.0.yml
+[🚎truby-33.0-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffleruby-33.0.yml/badge.svg
+[🚎2-cov-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/coverage.yml
+[🚎2-cov-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/coverage.yml/badge.svg
+[🚎3-hd-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/heads.yml
+[🚎3-hd-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/heads.yml/badge.svg
+[🚎5-st-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/style.yml
+[🚎5-st-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/style.yml/badge.svg
+[🚎9-t-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffle.yml
+[🚎9-t-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/truffle.yml/badge.svg
+[🚎10-j-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby.yml
+[🚎10-j-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/jruby.yml/badge.svg
+[🚎11-c-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/current.yml
+[🚎11-c-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/current.yml/badge.svg
+[🚎12-crh-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/dep-heads.yml
+[🚎12-crh-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/dep-heads.yml/badge.svg
+[🚎13-🔒️-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/locked_deps.yml
+[🚎13-🔒️-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/locked_deps.yml/badge.svg
+[🚎14-🔓️-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/unlocked_deps.yml
+[🚎14-🔓️-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/unlocked_deps.yml/badge.svg
+[🚎15-🪪-wf]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/license-eye.yml
+[🚎15-🪪-wfi]: {KJ|README:GH_REPOSITORY_URL}/actions/workflows/license-eye.yml/badge.svg
+[💎ruby-1.8i]: https://img.shields.io/badge/Ruby-1.8_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-1.9i]: https://img.shields.io/badge/Ruby-1.9_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-2.0i]: https://img.shields.io/badge/Ruby-2.0_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-2.1i]: https://img.shields.io/badge/Ruby-2.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-2.2i]: https://img.shields.io/badge/Ruby-2.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-2.3i]: https://img.shields.io/badge/Ruby-2.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-2.4i]: https://img.shields.io/badge/Ruby-2.4-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-2.5i]: https://img.shields.io/badge/Ruby-2.5-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-2.6i]: https://img.shields.io/badge/Ruby-2.6-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-2.7i]: https://img.shields.io/badge/Ruby-2.7-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-3.0i]: https://img.shields.io/badge/Ruby-3.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-3.1i]: https://img.shields.io/badge/Ruby-3.1-CC342D?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-3.4i]: https://img.shields.io/badge/Ruby-3.4-CC342D?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-4.0i]: https://img.shields.io/badge/Ruby-4.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
+[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
+[💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
+[💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
+[💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
+[💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
+[💎truby-24.2i]: https://img.shields.io/badge/Truffle_Ruby-24.2-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
+[💎truby-25.0i]: https://img.shields.io/badge/Truffle_Ruby-25.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
+[💎truby-33.0i]: https://img.shields.io/badge/Truffle_Ruby-33.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
+[💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
+[💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
+[💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1-FBE742?style=for-the-badge&logo=ruby&logoColor=red
+[💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2-FBE742?style=for-the-badge&logo=ruby&logoColor=red
+[💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3-FBE742?style=for-the-badge&logo=ruby&logoColor=red
+[💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
+[💎jruby-10.0i]: https://img.shields.io/badge/JRuby-10.0-FBE742?style=for-the-badge&logo=ruby&logoColor=red
+[💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
+[💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
+[🤝gh-issues]: {KJ|README:GH_ISSUES_URL}
+[🤝gh-pulls]: {KJ|README:GH_PULLS_URL}
+[🤝gl-issues]: {KJ|README:GL_ISSUES_URL}
+[🤝gl-pulls]: {KJ|README:GL_PULLS_URL}
+[🤝cb-issues]: {KJ|README:CB_ISSUES_URL}
+[🤝cb-pulls]: {KJ|README:CB_PULLS_URL}
+[🤝cb-donate]: https://donate.codeberg.org/
+[🤝contributing]: {KJ|README:GH_CONTRIBUTING_URL}
+[🏀codecov-g]: {KJ|README:CODECOV_GRAPH_URL}
+[🖐contrib-rocks]: https://contrib.rocks
+[🖐contributors]: {KJ|README:GH_CONTRIBUTORS_URL}
+[🖐contributors-img]: https://contrib.rocks/image?repo={KJ|README:CONTRIBUTORS_IMAGE_REPO}
+[🚎contributors-gl]: {KJ|README:GL_CONTRIBUTORS_URL}
+[🪇conduct]: {KJ|README:GH_CODE_OF_CONDUCT_URL}
+[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
+[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+[📌semver]: https://semver.org/spec/v2.0.0.html
+[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
+[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
+[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
+[📌changelog]: {KJ|README:GH_CHANGELOG_URL}
+[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
+[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
+[📌gitmoji]: https://gitmoji.dev
+[📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
+[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-5.053-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🔐security]: {KJ|README:GH_SECURITY_URL}
+[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
+{KJ|README:LICENSE_REFS}
+{KJ|README:FOSSA_REFS}
+[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
+[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
+[🚎yard-current]: http://rubydoc.info/gems/{KJ|GEM_NAME}
+[🚎yard-head]: https://{KJ|YARD_HOST}
+[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
+[💎SHA_checksums]: {KJ|README:SHA_CHECKSUMS_URL}
+[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
+[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
+[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
+[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
+[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/

data/lib/kettle/jem/templates/RUBOCOP.md.example

@@ -0,0 +1,78 @@
+# RuboCop Usage Guide
+
+## Overview
+
+A tale of two RuboCop plugin gems.
+
+### RuboCop Gradual
+
+This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
+
+### RuboCop LTS
+
+This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
+RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
+
+## Checking RuboCop Violations
+
+To check for RuboCop violations in this project, always use:
+
+```bash
+bundle exec rake rubocop_gradual:check
+```
+
+**Do not use** the standard RuboCop commands like:
+- `bundle exec rubocop`
+- `rubocop`
+
+## Understanding the Lock File
+
+The `.rubocop_gradual.lock` file is a work list, not a permanent baseline. Every entry represents a style issue that should be resolved by either fixing the code or making an intentional exception explicit.
+
+This allows the team to:
+
+1. Prevent new violations while existing issues are handled deliberately
+2. Track progress on code style improvements
+3. Distinguish temporary work items from intentional project style exceptions
+
+## Common Commands
+
+- **Check violations**
+    - `bundle exec rake rubocop_gradual`
+    - `bundle exec rake rubocop_gradual:check`
+- **(Safe) Autocorrect violations, and update lockfile if no new violations**
+  - `bundle exec rake rubocop_gradual:autocorrect`
+- **Force update the lock file (w/o autocorrect) to match violations present in code**
+  - `bundle exec rake rubocop_gradual:force_update`
+
+## Workflow
+
+1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
+   a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
+2. If there are violations, either:
+   - Fix them in your code
+   - Normalize intentional deviations with an explicit config or inline exception
+   - Run `bundle exec rake rubocop_gradual:force_update` only for temporary work items you cannot fix immediately
+3. Commit the updated `.rubocop_gradual.lock` file along with your changes
+
+## Explicit Style Exceptions
+
+Do not treat `.rubocop_gradual.lock` as a baseline. Treat it as a list of work that must be fixed or normalized into the styleguide.
+
+Prefer this order:
+
+1. Fix the code so it follows the configured styleguide.
+2. For intentional project conventions, add the narrowest useful override in `.rubocop.yml` or `.rubocop_rspec.yml`.
+3. For local intentional deviations, add a tightly scoped inline `rubocop:disable` / `rubocop:enable` around the exact line or block.
+4. Keep an entry in `.rubocop_gradual.lock` only as temporary work to be resolved later.
+
+Use configuration overrides when a deviation is structural, generated, path-specific, or applies consistently to a small set of files. Use inline disables when the exception is local and the reason is clearer at the code site than in global config.
+
+In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
+
+## Benefits of rubocop_gradual
+
+- Allows incremental adoption of code style rules
+- Prevents CI failures due to temporary pre-existing violations
+- Provides a clear work list of code style debt
+- Enables focused efforts on improving code quality over time