https://github.com/1git2clone/ruby-project-template
A simple Ruby project template using gem, bundle, rubocop, rake and minitest.
https://github.com/1git2clone/ruby-project-template
gem minitest rake rubocop ruby ruby-application ruby-gem template template-project
Last synced: 4 months ago
JSON representation
A simple Ruby project template using gem, bundle, rubocop, rake and minitest.
- Host: GitHub
- URL: https://github.com/1git2clone/ruby-project-template
- Owner: 1Git2Clone
- Created: 2024-08-10T09:34:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-10T12:42:11.000Z (over 1 year ago)
- Last Synced: 2025-03-17T16:15:47.846Z (9 months ago)
- Topics: gem, minitest, rake, rubocop, ruby, ruby-application, ruby-gem, template, template-project
- Language: Ruby
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Main
TODO: Delete this and the text below, and describe your gem
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/main`. To experiment with that code, run `bin/console` for an
interactive prompt.
## Installation
TODO: Replace
`UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your
gem name right after releasing it to RubyGems.org. Please do not do it earlier
due to security reasons. Alternatively, replace this section with instructions
to install your gem from git if you don't plan to release to RubyGems.org.
Install the gem and add to the application's Gemfile by executing:
bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
If bundler is not being used to manage dependencies, install the gem by executing:
gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
## Usage
TODO: Write usage instructions here
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake test` 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at
.