Skip to content

Commit 131287d

Browse files
committed
Make explicit that you can't use a version of spring direct from github
Closes #277
1 parent bc9e4fd commit 131287d

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ $ RAILS_VERSION="~> 3.2.0" rake test:acceptance
3131
The apps in `test/apps` will be named based on the rails version and the
3232
spring version.
3333

34+
## Testing with your app
35+
36+
You cannot link to a git repo from your Gemfile. Spring doesn't support
37+
this due to the way that it gets loaded (bypassing bundler for
38+
performance reasons).
39+
40+
Therefore, to test changes with your app, run `rake install` to properly
41+
install the gem on your system.
42+
3443
## Submitting a pull request
3544

3645
If your change is a bugfix or feature, please make sure you add to

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ Add spring to your Gemfile:
3434
gem "spring", group: :development
3535
```
3636

37+
(Note: using `gem "spring", git: "..."` *won't* work and is not a
38+
supported way of using spring.)
39+
3740
It's recommended to 'springify' the executables in your `bin/`
3841
directory:
3942

0 commit comments

Comments
 (0)