You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+17-2Lines changed: 17 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,11 +45,26 @@ The codespace environment includes a minimal Rails app with ViewComponent instal
45
45
2. Expose the port when prompted by the Visual Studio Code Web Editor.
46
46
3. Add the external URL to the config block in `config/application.rb` as prompted by the error.
47
47
48
+
## Running tests with Appraisal
49
+
50
+
This project uses [appraisal](https://github.com/thoughtbot/appraisal) to run tests for various versions of Ruby and Rails, and [appraisal-run](https://github.com/camertron/appraisal-run) to run them in Docker containers.
51
+
52
+
1. Install the dependencies: `bundle`
53
+
2. Make sure the tests pass: `appraisal-run gemfiles/*.gemfile -- bundle exec rake`
54
+
55
+
When a new version of Rails is released:
56
+
57
+
1. Add a new `appraise` block in `Appraisals`.
58
+
2. Run `bundle exec appraisal generate`
59
+
3. Update the gemfiles locks `appraisal-run gemfiles/*.gemfile -- bundle lock`
60
+
4. Make sure the tests pass: `appraisal-run gemfiles/*.gemfile -- bundle exec rake`
61
+
5. Commit and push the changes.
62
+
6. Release a new version.
63
+
48
64
## Submitting a pull request
49
65
50
66
1.[Fork](https://github.com/viewcomponent/view_component/fork) and clone the repository.
51
-
1. Configure and install the dependencies: `bundle exec appraisal install`.
52
-
2. Make sure the tests pass: `bundle exec appraisal rake` (see below for specific cases).
67
+
2. Make sure the tests pass: `appraisal-run gemfiles/*.gemfile -- bundle exec rake`.
53
68
3. Create a new branch: `git checkout -b my-branch-name`.
54
69
4. Add tests, make the change, and make sure the tests still pass.
55
70
5. Add an entry to the top of `docs/CHANGELOG.md` for the changes, no matter how small.
0 commit comments