Skip to content

Commit 70a00b0

Browse files
authored
Merge pull request #3166 from olleolleolle/patch-1
CONTRIBUTING.md: Explain prerequisites and multi-Rails version testing in new "Development" section
2 parents 8b8c3a4 + c80d4e5 commit 70a00b0

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,29 @@ Here are some ways *you* can contribute:
2222
[issues]: https://github.com/sferik/rails_admin/issues
2323
[gittip]: https://www.gittip.com/sferik/
2424

25+
## Development
26+
27+
### Running tests locally
28+
29+
To run the test suite, you need PhantomJS and ImageMagick (or GraphicsMagick).
30+
31+
Example on macOS using Homebrew:
32+
33+
brew cask install phantomjs
34+
brew install imagemagick
35+
bundle exec rspec
36+
37+
### Tests run against multiple versions of Rails
38+
39+
In CI, we use [appraisal] to run tests against multiple versions of Rails.
40+
The [gemfiles/ directory] contains the Gemfiles used to create the CI build
41+
matrix. See [the Travis CI configuration] for more details on what Ruby versions
42+
run what Rails versions.
43+
44+
[appraisal]: https://github.com/thoughtbot/appraisal
45+
[gemfiles/ directory]: ./gemfiles
46+
[the Travis CI configuration]: ./.travis.yml
47+
2548
## Getting Help
2649

2750
We use a [mailing list][list] for user support. If you've got a "how do

0 commit comments

Comments
 (0)