Skip to content

Commit

Permalink
Merge pull request #143 from pact-foundation/chore/dev_instructions
Browse files Browse the repository at this point in the history
chore(docs): add developing instructions
  • Loading branch information
YOU54F authored Oct 13, 2023
2 parents 20c1f10 + af71579 commit 4e5f6f3
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions DEVELOPING.md
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.

0 comments on commit 4e5f6f3

Please sign in to comment.