Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent 33c6cfc commit b99bb23b572a96c396c591b1b55b6351f71ec247 Rhys Powell committed Nov 23, 2011
Showing with 14 additions and 3 deletions.
  1. +14 −3 README.md
View
@@ -1,7 +1,18 @@
-# hackety-hack.com
+# hackety-hack.com #
[![Build status](https://secure.travis-ci.org/hacketyhack/hackety-hack.com.png)](http://travis-ci.org/#!/hacketyhack/hackety-hack.com)
-This is the source code for hackety-hack.com.
+[hackety-hack.com][hh.com] is the web backend powering the collaborative features of [Hackety Hack][hh]. It is written in Rails 3 and continues to be under active development (see 'Helping Out'), the switch to Rails 3 happened quite recently so there's still lots to be done.
-At the moment, we're re-building it for Rails 3. So there's not a lot of docs. Sorry about that!
+## Helping Out ##
+
+If you have any experience writing Rails apps, feel free to help out, we're open to pull requests as long as you follow a few conditions.
+
++ **Test your code**, we really can't stress this enough, ideally you should be practicing [TDD][tdd] and writing tests before you even write your code. If you don't test your code, we have no way of knowing if it works properly so please do test.
++ **If it's a major feature, file an issue**, if you file an issue we can discuss certain aspects of the new feature with you and ensure it's a good fit for hackety-hack.com.
+
+Additionally, if you're _not_ a developer and you have a feature you'd really like to see on the site, file an issue and we'll be sure to look into it on your behalf.
+
+[hh.com]: http://hackety-hack.com/
+[hh]: https://github.com/hacketyhack/hacketyhack
+[tdd]: http://en.wikipedia.org/wiki/Test-driven_development

0 comments on commit b99bb23

Please sign in to comment.