CONTRIBUTING.md in cpl-1.1.2 vs CONTRIBUTING.md in cpl-1.2.0
- old
+ new
@@ -10,16 +10,10 @@
# Create an alias in some local shell startup script, e.g., `.profile`, `.bashrc`, etc.
alias cpl="~/projects/heroku-to-control-plane/bin/cpl"
```
-Or set the path of the Ruby gem in your Gemfile.
-
-```ruby
-gem 'cpl', path: '~/projects/heroku-to-control-plane'
-```
-
## Linting/Testing
Before committing or pushing code, be sure to:
- Run `bundle exec rake update_command_docs` to sync any doc changes made in the source code to the docs
@@ -34,9 +28,11 @@
overcommit --install
```
## Debugging
+1. Use the `--verbose` option to see more detailed logs.
+2. Use the `--trace` option to see full logging of HTTP requests. Warning, this will display keys to your logs or console.
1. Add a breakpoint (`debugger`) to any line of code you want to debug.
2. Modify the `lib/command/test.rb` file to trigger the code you want to test. To simulate a command, you can use
`Cpl::Cli.start` (e.g., `Cpl::Cli.start(["deploy-image", "-a", "my-app-name"])` would be the same as running
`cpl deploy-image -a my-app-name`).
3. Run the `test` command in your test app with a `.controlplane` directory.