Skip to content

Commit 0d0fac6

Browse files
committed
Add CONTRIBUTING.md with basic setup
1 parent 204d174 commit 0d0fac6

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
## How to contribute
4+
5+
This gem uses [Appraisal](https:..//github.com/thoughtbot/appraisal) to test against multiple versions of Rails.
6+
7+
Some versions of Ruby are not supported using different versions of Rails. Checkout
8+
the .github/workflows/ci.yml and Appraisals file to see which versions of Ruby are tested.
9+
10+
## Running tests
11+
12+
Install dependencies:
13+
14+
```bash
15+
bundle install
16+
bundle exec appraisal bundle install
17+
```
18+
19+
Both Appraisals and ci.yml define what versions of Ruby and Rails are supported.
20+
21+
Run tests for all Rails versions supported for your Ruby version:
22+
23+
```bash
24+
bundle exec appraisal bundle exec rake
25+
```
26+
27+
Run tests against a specific version of Rails:
28+
29+
```bash
30+
bundle exec appraisal rails_main bundle exec rake
31+
```

0 commit comments

Comments
 (0)