Skip to content

Commit f657af7

Browse files
committed
Add explanation on how to get setup to run the full test suite.
1 parent c0d9f4e commit f657af7

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -351,12 +351,10 @@ end
351351

352352
The test suite is split into two groups `live` and `mock`.
353353

354-
The `live` tests are the ones in `features` folder and they simply exercise the GitHub API by making live requests and then being cached with VCR in directory named `features\cassettes`.
354+
The `live` tests are the ones in `features` folder and they simply exercise the GitHub API by making live requests and then being cached with VCR in directory named `features\cassettes`. For details on how to get setup please navigate to `features` folder.
355355

356356
The `mock` tests are in `spec` directory and their primary concern is to test the gem internals without the hindrance of external calls.
357357

358-
For details on how to get setup please navigate to `features` folder.
359-
360358
## Development
361359

362360
Questions or problems? Please post them on the [issue tracker](https://github.com/peter-murach/github/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running `bundle` and `rake`.

features/README.rdoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
= GithubAPI
22

3+
== Setup
4+
5+
Start by renaming the 'settings.yml.sample' file to 'settings.yml'. Then fill in all the information required such as authentication token etc. This should be enough to get the whole test suite run.
6+
37
== Running the specs and features
48

59
To run the specs first run the +bundle+ command to install the necessary gems and then +rake+ command to run the specs.

0 commit comments

Comments
 (0)