84 lines
3.9 KiB
Markdown
84 lines
3.9 KiB
Markdown
# Adopt a Hydrant
|
|
Claim responsibility for shoveling out a fire hydrant after it snows.
|
|
|
|
## <a name="screenshots">Screenshot</a>
|
|
|
|
|
|
## <a name="ci">Continuous Integration</a>
|
|
[](http://travis-ci.org/codeforamerica/adopt-a-hydrant)
|
|
|
|
## <a name="demo">Demo</a>
|
|
You can see a running version of the application at
|
|
[http://adopt-a-hydrant.herokuapp.com/](http://adopt-a-hydrant.herokuapp.com/).
|
|
|
|
## <a name="installation">Installation</a>
|
|
git clone git://github.com/codeforamerica/adopt-a-hydrant.git
|
|
cd adopt-a-hydrant
|
|
bundle install
|
|
|
|
## <a name="usage">Usage</a>
|
|
rails server
|
|
|
|
## <a name="contributing">Contributing</a>
|
|
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
|
|
|
|
Here are some ways *you* can contribute:
|
|
|
|
* by using alpha, beta, and prerelease versions
|
|
* by reporting bugs
|
|
* by suggesting new features
|
|
* by [translating to a new language](https://github.com/codeforamerica/adopt-a-hydrant/tree/master/config/locales)
|
|
* by writing or editing documentation
|
|
* by writing specifications
|
|
* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
|
|
* by refactoring code
|
|
* by closing [issues](https://github.com/codeforamerica/adopt-a-hydrant/issues)
|
|
* by reviewing patches
|
|
* [financially](https://secure.codeforamerica.org/page/contribute)
|
|
|
|
## <a name="issues">Submitting an Issue</a>
|
|
We use the [GitHub issue tracker](https://github.com/codeforamerica/adopt-a-hydrant/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 issuse by voting it up. When submitting a
|
|
bug report, please include a [Gist](https://gist.github.com/) 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.
|
|
|
|
## <a name="pulls">Submitting a Pull Request</a>
|
|
1. Fork the project.
|
|
2. Create a topic branch.
|
|
3. Implement your feature or bug fix.
|
|
4. Add tests for your feature or bug fix.
|
|
5. Run <tt>bundle exec rake test</tt>. If your changes are not 100% covered, go back to step 4.
|
|
6. Commit and push your changes.
|
|
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.)
|
|
|
|
## <a name="rubies">Supported Rubies</a>
|
|
This library aims to support and is [tested
|
|
against](http://travis-ci.org/codeforamerica/adopt-a-hydrant) the following
|
|
Ruby implementations:
|
|
|
|
* Ruby 1.8.7
|
|
* Ruby 1.9.2
|
|
* [Ruby Enterprise Edition](http://www.rubyenterpriseedition.com/)
|
|
|
|
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.
|
|
|
|
## <a name="copyright">Copyright</a>
|
|
Copyright (c) 2011 Code for America.
|
|
See [LICENSE](https://github.com/codeforamerica/adopt-a-hydrant/blob/master/LICENSE.md) for details.
|
|
|
|
[](http://stats.codeforamerica.org/projects/adopt-a-hydrant)
|