https://github.com/codeforamerica/gem_template

The Code for America RubyGem template
https://github.com/codeforamerica/gem_template

Last synced: 3 months ago
JSON representation

The Code for America RubyGem template

• Host: GitHub
• URL: https://github.com/codeforamerica/gem_template
• Owner: codeforamerica
• License: bsd-3-clause
• Created: 2011-03-19T22:46:19.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2015-04-17T19:56:53.000Z (over 9 years ago)
• Last Synced: 2024-04-09T01:07:32.926Z (7 months ago)
• Language: Ruby
• Homepage: http://codeforamerica.org/
• Size: 115 KB
• Stars: 15
• Watchers: 29
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# The Code for America RubyGem template

If you want to create a new Code for America gem, you can use this gem as a

template. It's similar to [suspenders][suspenders], but for RubyGems instead of

Rails.

[suspenders]: https://github.com/thoughtbot/suspenders

For more information on RubyGems, you should read the [RubyGems Manuals][manuals].

[manuals]: http://docs.rubygems.org/

After cloning this gem, you'll want to make the following changes:

1. Replace all instances of gem_template and GemTemplate with the snake_case and CamelCase name of your gem, respectively

2. Add a summary and description to the [gemspec][gemspec] file

[gemspec]: https://github.com/codeforamerica/gem_template/blob/master/gem_template.gemspec

This template includes:

* [RSpec][rspec] for isolation testing

* [SimpleCov][simplecov] for C0 code coverage

* [ZenTest][zentest] for continuous testing

* [YARD][yard] for documentation

[rspec]: https://github.com/rspec/rspec

[simplecov]: https://github.com/colszowka/simplecov

[yard]: https://github.com/lsegal/yard