choteaumt
/
adopt-a-hydrant
mirror of https://github.com/choteaumt/adopt-a-hydrant.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reformat [ci skip]

This commit is contained in:
Erik Michaels-Ober 2011-11-24 07:19:50 -08:00
parent 0019591c17
commit 412d3c5d35
1 changed files with 44 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -5,11 +5,15 @@ Claim responsibility for shoveling out a fire hydrant after it snows.
![Adopt a Hydrant](https://github.com/codeforamerica/adopt-a-hydrant/raw/master/screenshot.png "Adopt a Hydrant")
## <a name="ci"></a>Continuous Integration
[![Build Status](https://secure.travis-ci.org/codeforamerica/adopt-a-hydrant.png)](http://travis-ci.org/codeforamerica/adopt-a-hydrant)
[![Build Status](https://secure.travis-ci.org/codeforamerica/adopt-a-hydrant.png)][ci]
[ci]: http://travis-ci.org/codeforamerica/adopt-a-hydrant
## <a name="demo"></a>Demo
You can see a running version of the application at
[http://adopt-a-hydrant.herokuapp.com/](http://adopt-a-hydrant.herokuapp.com/).
[http://adopt-a-hydrant.herokuapp.com/][demo].
[demo]: http://adopt-a-hydrant.herokuapp.com/
## <a name="installation"></a>Installation
git clone git://github.com/codeforamerica/adopt-a-hydrant.git
@ -20,47 +24,62 @@ You can see a running version of the application at
rails server
## <a name="contributing"></a>Contributing
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
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
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 [translating to a new language][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 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 closing [issues][]
* by reviewing patches
* [financially](https://secure.codeforamerica.org/page/contribute)
* [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
## <a name="issues"></a>Submitting an Issue
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 issue 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.
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/
## <a name="pulls"></a>Submitting a Pull Request
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.
5. Run `bundle exec rake test`. 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.)
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="versions"></a>Supported Ruby Versions
This library aims to support and is [tested
against](http://travis-ci.org/codeforamerica/adopt-a-hydrant) the following
Ruby implementations:
This library aims to support and is [tested against][ci] the following Ruby
implementations:
* Ruby 1.8.7
* Ruby 1.9.2
* [Ruby Enterprise Edition](http://www.rubyenterpriseedition.com/)
* [Ruby Enterprise Edition][ree]
[ree]: http://www.rubyenterpriseedition.com/
If something doesn't work on one of these interpreters, it should be considered
a bug.
@ -77,7 +96,10 @@ 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"></a>Copyright
Copyright (c) 2011 Code for America.
See [LICENSE](https://github.com/codeforamerica/adopt-a-hydrant/blob/master/LICENSE.md) for details.
Copyright (c) 2011 Code for America. See [LICENSE][] for details.
[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/adopt-a-hydrant.png)](http://stats.codeforamerica.org/projects/adopt-a-hydrant)
[license]: https://github.com/codeforamerica/adopt-a-hydrant/blob/master/LICENSE.md
[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/adopt-a-hydrant.png)][tracker]
[tracker]: http://stats.codeforamerica.org/projects/adopt-a-hydrant