Skip to content

Commit 1e08066

Browse files
committed
Add contributing guide [ci skip]
Closes #251.
1 parent d87bfeb commit 1e08066

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing guide
2+
3+
## Getting set up
4+
5+
Check out the code and run `bundle install` as usual.
6+
7+
## Running tests
8+
9+
Running `rake` will run all tests. There are both unit tests and
10+
acceptance tests. You can run them individually with `rake test:unit` or
11+
`rake test:acceptance`.
12+
13+
If one doesn't already exist, the acceptance tests will generate a dummy
14+
Rails app in `test/apps/`. On each test run, the dummy app is copied to
15+
`test/apps/tmp/` so that any changes won't affect the pre-generated app
16+
(this saves us having to regenerate the app on each run).
17+
18+
If tests are failing and you don't know why, it might be that the
19+
pre-generated app has become inconsistent in some way. In that case the
20+
best solution is to purge it with `rm -rf test/apps/*` and then run the
21+
acceptance tests again, which will generate a new app.
22+
23+
## Testing different Rails versions
24+
25+
You can set the `RAILS_VERSION` environment variable:
26+
27+
```
28+
$ RAILS_VERSION="~> 3.2.0" rake test:acceptance
29+
```
30+
31+
The apps in `test/apps` will be named based on the rails version and the
32+
spring version.

0 commit comments

Comments
 (0)