This is a GitHub template for creating Ruby gems. Press Use this template to generate a project from this template. In the generated project, run this script to rename the gem to meet your needs:

ruby rename_template.rb

Note that to get the full benefits of the script, you will need the gh command installed.

This template is based on bundle gem with some notable improvements:

• GitHub Actions configuration
• Minitest, with minitest-rg for nicely formatted test output
• Rubocop with a good set of configuration
• CLI scaffolding, built on top of Thor (optional; for more background, read Fixing Thor’s CLI Quirks)
• release-drafter GitHub Action for automating release notes
• A rake bump task to keep your Ruby and Bundler dependencies up to date
• A nice README with badges ready to go (see below)

TODO: Description of this gem goes here.

• Quick start
• Support
• License
• Code of conduct
• Contribution guide

gem install example

require "example"

If you want to report a bug, or have ideas, feedback or questions about the gem, let me know via GitHub issues and I will do my best to provide a helpful answer. Happy hacking!

The gem is available as open source under the terms of the MIT License.

Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Pull requests are welcome!