Make contributing easier and more awesome.

nuclearsandwich · nuclearsandwich · commit 3b297a9c1e43 · 2013-04-20T11:45:20.000-07:00
This pull request adds the following:

Script Bootstrap
----------------

`script/bootstrap`, conventionally used to get new clones up and running
in a single command. This one checks for Ruby and Mongo and then,
assuming both are present, installs (if necessary) and runs bundler. The
idea is that there are only two things new contributors ever need to do.

1. git clone
2. script/bootstrap

If we really like it, we can make it smart enough to recommend ways to
*get* MongoDB and Ruby based on the OS, but I feel like that's a bit
overkill for a v1. The idea is that contribution should be as smooth as
possible so would-be helpers can start helping immediately. The script
should remain idempotent so if changes are made to the application,
existing contributors can pull, run script/bootstrap, and be ready to go
without borking their existing dev instance.

One thing this does as a side effect is specify a path for vendored gems
and binstubs, this is why the .gitignore changes were made.

.ruby-version
-------------

Specify a Ruby version using the ruby manager agnostic version of an
rvmrc.

CONTRIBUTING.md
---------------

When you create a new Pull Request or Issue, GitHub will highlight a
block above the new issue/PR title calling attention to the repository's
CONTRIBUTING.md file, should one exist. This is an expanded version of
the Helping Out section from the README.
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ tmp/
 .DS_Store
 *.swp
 .redcar
+bin/
diff --git a/.ruby-version b/.ruby-version
@@ -0,0 +1 @@
+ ruby-1.9.3-p392
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+# Thanks for helping! #
+
+## Questions ##
+
+If you're asking a question about Hackety Hack itself, check out the [Hackety
+Hack repository][hh].
+Otherwise, go ahead and open an [issue][issues] and let us know!
+
+## Bugs ##
+
+If you notice a bug in Hackety-Hack.com, this is the place to let us know.
+Please tell us:
+
+- Which url the bug occurred at
+- What steps we can take to reproduce this bug
+- If the bug is visual, including a screenshot is really helpful.
+
+## Pull Requests ##
+
+We :heart: pull requests; We :heart::blue_heart::green_heart: Pull Requests with tests. In fact, we don't want to accept pull requests without relevant tests. If you're not sure if the feature you want is welcome and you want to check with us, feel free to create [an issue][issues] or if you're just totally driven to make it happen, spike it out and open a pull request, but we'll ask you to add tests before it's merged.
+
+
+[hh]:     https://github.com/hacketyhack/hacketyhack
+[issues]: https://github.com/hacketyhack/hackety-hack.com/issues
diff --git a/README.md b/README.md
@@ -11,8 +11,24 @@ If you have any experience writing Rails apps, feel free to help out, we're open
 + **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.
+## Getting Started ##
+
+Once you've cloned this repository, running `script/bootstrap` should tell you everything you need to know.
+
+Dependencies for the curious:
+
+- Ruby: 1.9.3 is preferred.
+- MongoDB: 2.2.x or 2.4.x
+
+As long as you have those things, the script will handle the rest as best it can, including installing the gem dependencies with Bundler.
+
+If the tests aren't passing when you clone, open [an issue][issues] or drop into
+[#hacketyhack on freenode][irc].
+
+Additionally, if you're _not_ a developer and you have a feature you'd really like to see on the site, file [an issue][issues] 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
+[irc]: http://webchat.freenode.net/#hacketyhack
+[issues]: https://github.com/hacketyhack/hackety-hack.com/issues
+[tdd]:    http://en.wikipedia.org/wiki/Test-driven_development
diff --git a/script/bootstrap b/script/bootstrap
@@ -0,0 +1,58 @@
+#!/bin/dash
+
+go_go_gadget_bootstrap() {
+	check_ruby
+	check_mongo
+	check_bundler
+	bail_unless_chill
+	good_luck_have_fun
+}
+
+check_mongo() {
+	which mongo > /dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		NOMONGO="Hey, in order to remember stuff I need MongoDB"
+	fi
+}
+
+check_bundler() {
+	if [ -z "$NORUBY" ]; then
+		which bundle  > /dev/null 2>&1
+		if [ $? -ne 0 ]; then
+			gem install bundler || exit 2
+		fi
+	fi
+}
+
+good_luck_have_fun() {
+	bundle install --path .bundle --binstubs bin
+	bin/rake spec cucumber
+}
+
+check_ruby() {
+	which ruby > /dev/null 2>&1
+	if [ $? -ne 0 ]; then
+		NORUBY="Whoa there, looks like you're missing Ruby!"
+	else
+		ruby -v  |  grep '^ruby 1.9.3' > /dev/null 2>&1
+		if [ $? -ne 0 ]; then
+			NORUBY="Hrmm, your Ruby version isn't Ruby 1.9.3, that's really what I prefer."
+		fi
+	fi
+}
+
+bail_unless_chill() {
+	if [ "$NORUBY" -a "$NOMONGO" ]; then
+		echo "$NORUBY"
+		echo "$NOMONGO"
+		exit 1
+	elif [ "$NORUBY" ]; then
+		echo "$NORUBY"
+		exit 1
+	elif [ "$NOMONGO" ]; then
+		echo "$NOMONGO"
+		exit 1
+	fi
+}
+
+go_go_gadget_bootstrap

-Original file line number
+Diff line change
 .DS_Store
 *.swp
 .redcar
 +bin/