Skip to content

Commit b99bb23

Browse files
author
Rhys Powell
committed
Update README.md
1 parent 33c6cfc commit b99bb23

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
1-
# hackety-hack.com
1+
# hackety-hack.com #
22

33
[![Build status](https://secure.travis-ci.org/hacketyhack/hackety-hack.com.png)](http://travis-ci.org/#!/hacketyhack/hackety-hack.com)
44

5-
This is the source code for hackety-hack.com.
5+
[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.
66

7-
At the moment, we're re-building it for Rails 3. So there's not a lot of docs. Sorry about that!
7+
## Helping Out ##
8+
9+
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.
10+
11+
+ **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.
12+
+ **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.
13+
14+
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.
15+
16+
[hh.com]: http://hackety-hack.com/
17+
[hh]: https://github.com/hacketyhack/hacketyhack
18+
[tdd]: http://en.wikipedia.org/wiki/Test-driven_development

0 commit comments

Comments
 (0)