diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ca81e0 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +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") + +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 +* by closing [issues](http://github.com/codeforamerica/adopt-a-hydrant/issues) +* by reviewing patches +* [financially](https://secure.codeforamerica.org/page/contribute) + +Submitting an Issue +------------------- +We use the [GitHub issue tracker](http://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](http://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. + +Submitting a Pull Request +------------------------- +1. Fork the project. +2. Create a topic branch. +3. Implement your feature or bug fix. +4. Add specs for your feature or bug fix. +5. Commit and push your changes. +6. 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.) + +Copyright +--------- +Copyright (c) 2011 Code for America +See [LICENSE](https://github.com/codeforamerica/adopt-a-hydrant/blob/master/LICENSE.md) for details. diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..6350238 Binary files /dev/null and b/screenshot.png differ