Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

added a section to the README on getting a dev environment up and run…

…ning
  • Loading branch information...
commit 0c40023cd72ffbe55f492f6162f10a0d62671a11 1 parent 96c703e
@justinfrench authored
Showing with 26 additions and 5 deletions.
  1. +0 −4 DEVELOPER_INSTALLATION
  2. +26 −1 README.textile
View
4 DEVELOPER_INSTALLATION
@@ -1,4 +0,0 @@
-rvm gemset create formtastic-rails-3
-rvm gemset use formtastic-rails-3
-gem install rails rspec rspec-rails rspec_tag_matchers hpricot
-rake spec
View
27 README.textile
@@ -634,12 +634,37 @@ h2. Compatibility
h2. How to contribute
-Please ensure that you provide appropriate spec/test coverage and ensure the documentation is up-to-date. Bonus points if you perform your changes in a clean topic branch rather than master, and if you create an issue on GH for us to discuss your changes. Pull requests tend to get lost.
+Please ensure that you provide appropriate spec/test coverage and ensure the documentation is up-to-date. Bonus points if you perform your changes in a clean topic branch rather than master, and if you create a pull request for your changes to be discussed and reviewed.
Please also keep your commits *atomic* so that they are more likely to apply cleanly. That means that each commit should contain the smallest possible logical change. Don't commit two features at once, don't update the gemspec at the same time you add a feature, don't fix a whole bunch of whitespace in a file at the same time you change a few lines, etc, etc.
For significant changes, you may wish to discuss your idea on the Formtastic Google group before coding to ensure that your change is likely to be accepted. Formtastic relies heavily on i18n, so if you're unsure of the impact this has on your changes, please discuss them with the group.
+See below for installation of a development environment.
+
+
+h2. Development Environment
+
+We currently support both Rails 2 and Rails 3, under Ruby 1.8.7-ish (and 1.9.2-ish). That means, at a bare minimum, you'll want to set-up two rvm gemsets to run your specs against. So, fork the project on Github, clone it, make some gemsets, run bundler, run your specs and then finally set-up an .rvmrc file that specifies Rails 3 as your default gemset and cd back into that directory to load in the .rvmrc file. Something like this:
+
+<pre>
+ $ cd ~/code/formtastic
+ $ rvm gemset create formtastic-rails3
+ $ rvm gemset use formtastic-rails3
+ $ gem install bundler
+ $ bundle install
+ $ rake spec
+ $ rm Gemfile.lock
+ $ rvm gemset create formtastic-rails2
+ $ rvm gemset use formtastic-rails2
+ $ gem install bundler
+ $ RAILS_2=true bundle install
+ $ rake spec
+ $ touch .rvmrc
+ $ echo "rvm gemset use formtastic-rails-3" > .rvmrc
+ $ cd ~/code/formtastic
+</pre>
+
h2. Maintainers & Contributors
Please sign in to comment.
Something went wrong with that request. Please try again.