adopt-a-hydrant/README.md

68 lines
2.6 KiB
Markdown
Raw Normal View History

2011-04-28 14:35:15 +00:00
Adopt a Hydrant
===============
Claim responsibility for shoveling out a fire hydrant after it snows.
Screenshot
----------
![Adopt a Hydrant](https://github.com/codeforamerica/adopt-a-hydrant/raw/master/screenshot.png "Adopt a Hydrant")
2011-05-09 03:27:32 +00:00
Continuous Integration
----------------------
[![Build Status](http://travis-ci.org/codeforamerica/adopt-a-hydrant.png)](http://travis-ci.org/codeforamerica/adopt-a-hydrant)
2011-05-09 03:27:45 +00:00
Demo
----
You can see a running version of the application at
[http://adopt-a-hydrant.heroku.com/](http://adopt-a-hydrant.heroku.com/).
2011-05-09 03:27:45 +00:00
2011-05-09 03:28:40 +00:00
Installation
------------
git clone git://github.com/codeforamerica/adopt-a-hydrant.git
cd adopt-a-hydrant
bundle install
2011-05-09 03:29:19 +00:00
Usage
-----
rails server
2011-04-28 14:35:15 +00:00
Contributing
------------
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 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
2011-05-07 18:52:13 +00:00
* by closing [issues](https://github.com/codeforamerica/adopt-a-hydrant/issues)
2011-04-28 14:35:15 +00:00
* by reviewing patches
* [financially](https://secure.codeforamerica.org/page/contribute)
Submitting an Issue
-------------------
2011-05-07 18:52:13 +00:00
We use the [GitHub issue tracker](https://github.com/codeforamerica/adopt-a-hydrant/issues) to track bugs and
2011-04-28 14:35:15 +00:00
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
2011-05-07 19:02:22 +00:00
bug report, please include a [Gist](https://gist.github.com/) that includes a stack trace and any
2011-04-28 14:35:15 +00:00
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.
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.
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.)
2011-04-28 14:35:15 +00:00
Copyright
---------
2011-04-28 14:37:54 +00:00
Copyright (c) 2011 Code for America.
2011-04-28 14:35:15 +00:00
See [LICENSE](https://github.com/codeforamerica/adopt-a-hydrant/blob/master/LICENSE.md) for details.