2011-08-19 20:29:45 +00:00
|
|
|
# Adopt a Hydrant
|
2011-04-28 14:35:15 +00:00
|
|
|
Claim responsibility for shoveling out a fire hydrant after it snows.
|
|
|
|
|
|
2011-11-23 15:08:19 +00:00
|
|
|
## <a name="screenshots"></a>Screenshot
|
2011-04-28 14:35:15 +00:00
|
|
|
|
|
|
|
|
|
2011-12-01 13:57:46 +00:00
|
|
|
## <a name="ci"></a>Build Status
|
2011-11-24 15:19:50 +00:00
|
|
|
[][ci]
|
|
|
|
|
|
|
|
|
|
[ci]: http://travis-ci.org/codeforamerica/adopt-a-hydrant
|
2011-05-09 03:27:32 +00:00
|
|
|
|
2011-12-01 13:57:46 +00:00
|
|
|
## <a name="dependencies"></a>Dependency Status
|
|
|
|
|
[][gemnasium]
|
|
|
|
|
|
|
|
|
|
[gemnasium]: https://gemnasium.com/codeforamerica/adopt-a-hydrant
|
|
|
|
|
|
2011-11-23 15:08:19 +00:00
|
|
|
## <a name="demo"></a>Demo
|
2011-05-09 03:27:45 +00:00
|
|
|
You can see a running version of the application at
|
2011-11-24 15:19:50 +00:00
|
|
|
[http://adopt-a-hydrant.herokuapp.com/][demo].
|
|
|
|
|
|
|
|
|
|
[demo]: http://adopt-a-hydrant.herokuapp.com/
|
2011-05-09 03:27:45 +00:00
|
|
|
|
2011-11-23 15:08:19 +00:00
|
|
|
## <a name="installation"></a>Installation
|
2011-05-09 03:28:40 +00:00
|
|
|
git clone git://github.com/codeforamerica/adopt-a-hydrant.git
|
|
|
|
|
cd adopt-a-hydrant
|
|
|
|
|
bundle install
|
|
|
|
|
|
2011-11-23 15:08:19 +00:00
|
|
|
## <a name="usage"></a>Usage
|
2011-05-09 03:29:19 +00:00
|
|
|
rails server
|
|
|
|
|
|
2011-11-23 15:08:19 +00:00
|
|
|
## <a name="contributing"></a>Contributing
|
2011-11-24 15:19:50 +00:00
|
|
|
In the spirit of [free software][free-sw], **everyone** is encouraged to help
|
|
|
|
|
improve this project.
|
|
|
|
|
|
|
|
|
|
[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
|
2011-04-28 14:35:15 +00:00
|
|
|
|
|
|
|
|
Here are some ways *you* can contribute:
|
|
|
|
|
|
|
|
|
|
* by using alpha, beta, and prerelease versions
|
|
|
|
|
* by reporting bugs
|
|
|
|
|
* by suggesting new features
|
2011-11-24 15:19:50 +00:00
|
|
|
* by [translating to a new language][locales]
|
2011-04-28 14:35:15 +00:00
|
|
|
* by writing or editing documentation
|
|
|
|
|
* by writing specifications
|
2011-11-24 15:19:50 +00:00
|
|
|
* by writing code (**no patch is too small**: fix typos, add comments, clean up
|
|
|
|
|
inconsistent whitespace)
|
2011-04-28 14:35:15 +00:00
|
|
|
* by refactoring code
|
2011-11-24 15:19:50 +00:00
|
|
|
* by closing [issues][]
|
2011-04-28 14:35:15 +00:00
|
|
|
* by reviewing patches
|
2011-11-24 15:19:50 +00:00
|
|
|
* [financially][]
|
|
|
|
|
|
|
|
|
|
[locales]: https://github.com/codeforamerica/adopt-a-hydrant/tree/master/config/locales
|
|
|
|
|
[issues]: https://github.com/codeforamerica/adopt-a-hydrant/issues
|
|
|
|
|
[financially]: https://secure.codeforamerica.org/page/contribute
|
2011-04-28 14:35:15 +00:00
|
|
|
|
2011-11-23 15:08:19 +00:00
|
|
|
## <a name="issues"></a>Submitting an Issue
|
2011-11-24 15:19:50 +00:00
|
|
|
We use the [GitHub issue tracker][issues] to track bugs and features. Before
|
|
|
|
|
submitting a bug report or feature request, check to make sure it hasn't
|
|
|
|
|
already been submitted. You can indicate support for an existing issue by
|
|
|
|
|
voting it up. When submitting a bug report, please include a [Gist][] that
|
|
|
|
|
includes a stack trace and any details that may be necessary to reproduce the
|
|
|
|
|
bug, including your gem version, Ruby version, and operating system. Ideally, a
|
|
|
|
|
bug report should include a pull request with failing specs.
|
|
|
|
|
|
|
|
|
|
[gist]: https://gist.github.com/
|
2011-04-28 14:35:15 +00:00
|
|
|
|
2011-11-23 15:08:19 +00:00
|
|
|
## <a name="pulls"></a>Submitting a Pull Request
|
2011-04-28 14:35:15 +00:00
|
|
|
1. Fork the project.
|
|
|
|
|
2. Create a topic branch.
|
|
|
|
|
3. Implement your feature or bug fix.
|
2011-05-09 03:49:02 +00:00
|
|
|
4. Add tests for your feature or bug fix.
|
2011-11-24 15:19:50 +00:00
|
|
|
5. Run `bundle exec rake test`. If your changes are not 100% covered, go back
|
|
|
|
|
to step 4.
|
2011-05-09 03:49:02 +00:00
|
|
|
6. Commit and push your changes.
|
2011-11-24 15:19:50 +00:00
|
|
|
7. Submit a pull request. Please do not include changes to the gemspec or
|
|
|
|
|
version file. (If you want to create your own version for some reason,
|
|
|
|
|
please do so in a separate commit.)
|
2011-04-28 14:35:15 +00:00
|
|
|
|
2011-11-23 15:08:19 +00:00
|
|
|
## <a name="versions"></a>Supported Ruby Versions
|
2011-11-24 15:19:50 +00:00
|
|
|
This library aims to support and is [tested against][ci] the following Ruby
|
|
|
|
|
implementations:
|
2011-07-27 17:18:03 +00:00
|
|
|
|
|
|
|
|
* Ruby 1.8.7
|
|
|
|
|
* Ruby 1.9.2
|
2011-11-24 15:19:50 +00:00
|
|
|
* [Ruby Enterprise Edition][ree]
|
|
|
|
|
|
|
|
|
|
[ree]: http://www.rubyenterpriseedition.com/
|
2011-07-27 17:18:03 +00:00
|
|
|
|
|
|
|
|
If something doesn't work on one of these interpreters, it should be considered
|
|
|
|
|
a bug.
|
|
|
|
|
|
|
|
|
|
This library may inadvertently work (or seem to work) on other Ruby
|
|
|
|
|
implementations, however support will only be provided for the versions listed
|
|
|
|
|
above.
|
|
|
|
|
|
|
|
|
|
If you would like this library to support another Ruby version, you may
|
|
|
|
|
volunteer to be a maintainer. Being a maintainer entails making sure all tests
|
|
|
|
|
run and pass on that implementation. When something breaks on your
|
|
|
|
|
implementation, you will be personally responsible for providing patches in a
|
|
|
|
|
timely fashion. If critical issues for a particular implementation exist at the
|
|
|
|
|
time of a major release, support for that Ruby version may be dropped.
|
|
|
|
|
|
2011-11-23 15:08:19 +00:00
|
|
|
## <a name="copyright"></a>Copyright
|
2011-11-24 15:19:50 +00:00
|
|
|
Copyright (c) 2011 Code for America. See [LICENSE][] for details.
|
|
|
|
|
|
|
|
|
|
[license]: https://github.com/codeforamerica/adopt-a-hydrant/blob/master/LICENSE.md
|
|
|
|
|
|
|
|
|
|
[][tracker]
|
2011-05-27 22:13:30 +00:00
|
|
|
|
2011-11-24 15:19:50 +00:00
|
|
|
[tracker]: http://stats.codeforamerica.org/projects/adopt-a-hydrant
|
