-
Notifications
You must be signed in to change notification settings - Fork 151
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CONTRIBUTING.md with basic setup
- Loading branch information
1 parent
204d174
commit 660f289
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Contributing | ||
|
||
## How to contribute | ||
|
||
This gem uses [Appraisal](https:..//github.com/thoughtbot/appraisal) to test against multiple versions of Rails. | ||
|
||
Some versions of Ruby are not supported using different versions of Rails. Checkout | ||
the .github/workflows/ci.yml and Appraisals file to see which versions of Ruby are tested. | ||
|
||
## Running tests | ||
|
||
Install dependencies: | ||
|
||
```bash | ||
bundle install | ||
bundle exec appraisal bundle install | ||
``` | ||
|
||
Both Appraisals and ci.yml define what versions of Ruby and Rails are supported. | ||
|
||
Run tests for all Rails versions supported for your Ruby version: | ||
|
||
```bash | ||
bundle exec appraisal bundle exec rake | ||
``` | ||
|
||
Run tests against a specific version of Rails: | ||
|
||
```bash | ||
bundle exec appraisal rails_main bundle exec rake | ||
``` |