Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 47 lines (30 sloc) 1.236 kb
7b9bf81 Flaviu Simihaian added the contributing wiki to the project for symlinking with relish
FlaviuSim authored
1 ## Contributing
2
037a217 Myron Marston Fix links in contributing.md to use markdown format rather than github w...
authored
3 Install [bundler](http://gembundler.com/) and use it to install all the development dependencies:
7b9bf81 Flaviu Simihaian added the contributing wiki to the project for symlinking with relish
FlaviuSim authored
4
5 ```console
6 gem install bundler
7 bundle install
8 ```
9
10 Next setup the Git submodules:
11
12 ```console
13 git submodule init
14 git submodule update
15 ```
16
17 or using the single command form
18
19 ```console
20 git submodule update --init
21 ```
22
23 You should be able to run the tests now:
24
25 ```console
26 bundle exec rake
27 ```
28
037a217 Myron Marston Fix links in contributing.md to use markdown format rather than github w...
authored
29 VCR uses [RSpec 2](http://github.com/rspec/rspec) for unit tests. The specs are written in a very "focused" style, where each spec is concerned only with exercising the object under test, using mocks as necessary. You can run the specs using `rake spec`.
7b9bf81 Flaviu Simihaian added the contributing wiki to the project for symlinking with relish
FlaviuSim authored
30
037a217 Myron Marston Fix links in contributing.md to use markdown format rather than github w...
authored
31 [Cucumber](http://cukes.info/) is used for end-to-end full stack integration tests that also function as VCR's documentation.
7b9bf81 Flaviu Simihaian added the contributing wiki to the project for symlinking with relish
FlaviuSim authored
32
33 ## Problems running bundle install?
34
35 If you get an error while running `bundle install`, it may be one of the "extras" gems which are not required for development. Try installing it without these gems.
36
37 ```console
38 bundle install --without extras
39 ```
40
41 If you are getting an error installing `rb-fsevent` gem, you may want to temporarily change the Gemfile to use the pre-release version of the gem.
42
43 ```ruby
44 gem 'rb-fsevent', '0.9.0.pre4'
45 ```
46
Something went wrong with that request. Please try again.