Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lightyrs/gem_template
The Code for America RubyGem template
https://github.com/lightyrs/gem_template
Last synced: about 2 months ago
JSON representation
The Code for America RubyGem template
- Host: GitHub
- URL: https://github.com/lightyrs/gem_template
- Owner: lightyrs
- License: bsd-3-clause
- Fork: true (codeforamerica/gem_template)
- Created: 2012-05-29T17:33:09.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2012-05-07T20:22:41.000Z (over 12 years ago)
- Last Synced: 2024-04-15T12:17:27.293Z (5 months ago)
- Language: Ruby
- Homepage: http://codeforamerica.org/
- Size: 81.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- 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
[zentest]: https://github.com/seattlerb/zentest
[yard]: https://github.com/lsegal/yard
[](http://stats.codeforamerica.org/projects/gem_template)