Skip to content

Commit c4deb3d

Browse files
committed
Developer Setup Docs [ci skip]
1 parent 53728c2 commit c4deb3d

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,27 @@ task default: 'bundle:audit'
136136

137137
$ gem install bundler-audit
138138

139+
## Developer Setup
140+
141+
For contributors to bundler-audit, to setup your environment and run the test suite:
142+
143+
```bash
144+
# Fork repo on GitHub, then ...
145+
git clone FORK_URL
146+
147+
cd bundler-audit/
148+
149+
bundle install
150+
151+
bundle exec gem install bundler
152+
153+
# Clone the data/ruby-advisory-db submodule (required by tests)
154+
git submodule update --init
155+
156+
# Run specs
157+
bundle exec rake test
158+
```
159+
139160
## License
140161

141162
Copyright (c) 2013-2015 Hal Brodigan (postmodern.mod3 at gmail.com)

0 commit comments

Comments
 (0)