Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/gem_template
. To experiment with that code, run bin/console
for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
- clone this repo
- update details in gemspec
- comes with github action to autmatic bump version and release on master branch after rspec and rubocop pass based on git commit message. Versioning follow semvar
git commit -am "Patch: some version" -> bump patch version
git commit -am "Minor: add feature" -> bump minor version
git commit -am "Major: add feature" -> bump major version
git commit -am "Add feature" -> default to bump patch version
Add this line to your application's Gemfile:
gem 'gem_template'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install gem_template
TODO: Write usage instructions here
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and the created tag, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gem_template. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the GemTemplate project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.