diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2015-12-29 01:03:44 -0700 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2015-12-29 01:03:44 -0700 |
| commit | 1f1a80eb9f59173da4227dc7b13a1904f3241178 (patch) | |
| tree | 25c321ed7a11f0e5d324d8192ba66fa4238900ed /CONTRIBUTING.adoc | |
| parent | 5d30ac8bf2ca65ff12c9f49024ca96f5727b487e (diff) | |
update contributing guidelines
- document how to install Bundler if the bundle command is missing
- recommend using the pattern issue-XYZ for the name of the topic branch
Diffstat (limited to 'CONTRIBUTING.adoc')
| -rw-r--r-- | CONTRIBUTING.adoc | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index ce1d7db7..d729c530 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -33,8 +33,9 @@ An ideal bug report would include a pull request with failing specs. == Submitting a Pull Request . {uri-fork-help}[Fork the repository]. -. Run `bundle install` to install dependencies. -. {uri-branch-help}[Create a topic branch]. +. Run `bundle` to install development dependencies. + * If the `bundle` command is not available, run `gem install bundler` to install it. +. {uri-branch-help}[Create a topic branch] (preferably using the pattern `issue-XYZ`, where `XYZ` is the issue number). . Add tests for your unimplemented feature or bug fix. (See <<writing-and-executing-tests>>) . Run `bundle exec rake` to run the tests. If your tests pass, return to step 3. |