-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): add developing instructions
- Loading branch information
Showing
1 changed file
with
17 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Developing | ||
|
||
## Testing pact_broker-client locally | ||
|
||
1. Make sure you have `ruby` available on the command line | ||
2. Install with `bundle install` | ||
3. Run tests with `bundle exec rake` | ||
4. Run individual test with `rspec <path to test>` | ||
5. Run one of the scripts in `./example/scripts`, see the readme for more detail, and scripts | ||
|
||
## Available Rake tasks | ||
|
||
1. check `bundle exec rake --tasks` | ||
|
||
## Generating docs | ||
|
||
If you change the CLI commands, run `bundle exec script/update-cli-usage-in-readme.rb` to update the `README.md` automatically. |