From 0f76c8f33a355bd8074f009e8414719731ab6727 Mon Sep 17 00:00:00 2001 From: Vincent Truong <131324731+vincent-truong-dev@users.noreply.github.com> Date: Wed, 7 Feb 2024 10:59:54 -0600 Subject: [PATCH] Add readme about debugging using pry remote (#4085) * Add readme about debugging * Mention regular pry; remove long example --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index a43a64dcf3..19dc1c3636 100644 --- a/README.md +++ b/README.md @@ -166,6 +166,12 @@ Users that are frequent contributors and are involved in discussion (join the sl ### Stay Scoped Try to keep your PRs limited to one particular issue, and don't make changes that are out of scope for that issue. If you notice something that needs attention but is out of scope, please [create a new issue](https://github.com/rubyforgood/human-essentials/issues/new). +## Debugging +If starting server directly, via `rail s` or `rail console`, or built-in debugger in RubyMine, then you can use `binding.pry` to debug. Drop the pry where you want the execution to pause. + +If starting via Procfile with `bin/start`, then drop a ``binding.remote_pry`` into the line where you want execution to pause at. Then run ``pry-remote`` in the terminal to connect to it. +https://github.com/Mon-Ouie/pry-remote + ## Testing 🧪 ### Writing Tests/Specs