Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): add developing instructions #143

Merged
merged 1 commit into from
Oct 13, 2023
Merged

chore(docs): add developing instructions #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions DEVELOPING.md
View file
Open in desktop
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.