Skip to content

fix: Clarify transient debug-break guidance#1289

Merged
hatayama merged 8 commits into
v3-betafrom
feature/improve-skill
Jun 6, 2026
Merged

fix: Clarify transient debug-break guidance#1289
hatayama merged 8 commits into
v3-betafrom
feature/improve-skill

Conversation

@hatayama

@hatayama hatayama commented Jun 6, 2026

Copy link
Copy Markdown
Owner

Summary

  • Clarifies that wait-for-debug-break should be used when transient PlayMode or E2E state transitions cannot be proven by screenshots, durable state, or value logs alone.
  • Keeps the source skill and checked-in generated skill copies aligned for Claude and Agents consumers.

User Impact

  • Agents get clearer guidance to pause at natural transition points after simulated input or gameplay events are consumed.
  • The skill now discourages weaker substitutes such as generic action logs, sleeps/retries, testing-only counters, or Time.timeScale changes when debug-break evidence is needed.

Changes

  • Simplified the wait-for-debug-break skill workflow text and marker placement guidance.
  • Updated the source package skill and synchronized the generated Claude and Agents skill copies.

Verification

  • git diff --check origin/v3-beta...HEAD
  • scripts/build-go-cli.sh
  • cli/dist/darwin-arm64/uloop --version3.0.0-beta.26
  • cli/dist/darwin-arm64/uloop skills install --claude --agents --project-path "$(git rev-parse --show-toplevel)"

hatayama added 3 commits June 6, 2026 11:00
Make the source skill markdown readable for Japanese editing while preserving the command examples and marker workflow.
Restore English wording for the edited source skill while preserving the simplified workflow and command examples.
@coderabbitai

coderabbitai Bot commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Single-file documentation updates to the uloop-wait-for-debug-break skill across three SKILL.md copies: description now emphasizes pausing for variable/hierarchy inspection and reliable screenshots; workflow clarifies enabling the marker before triggering and includes dynamic code triggers; Marker Placement and Safety bullets and heading capitalization revised.

Changes

uloop-wait-for-debug-break skill documentation

Layer / File(s) Summary
Skill description and workflow instructions
Packages/src/Editor/CliOnlyTools~/PausePoint/Skill/SKILL.md, .agents/skills/uloop-wait-for-debug-break/SKILL.md, .claude/skills/uloop-wait-for-debug-break/SKILL.md
Top-level description refocused on pausing for variable/hierarchy inspection and capturing reliable screenshots (avoid Time.timeScale = 0). Workflow step reworded to enable the debug-break marker before triggering the target code path; trigger examples expanded to explicitly include dynamic code and similar commands.
Marker Placement and Safety guidance
Packages/src/Editor/CliOnlyTools~/PausePoint/Skill/SKILL.md, .agents/skills/uloop-wait-for-debug-break/SKILL.md, .claude/skills/uloop-wait-for-debug-break/SKILL.md
Section heading standardized to "Marker Placement". Multiple bullet points under "Marker Placement" and "Safety" rewritten: timing/phase guidance and Domain Reload/tool-busy notes clarified, stricter guidance on separate IDs per phase, retained notes on stable string IDs and avoiding side-effect expressions as IDs, and removed the prior statement that UnityCliLoopDebug.Break is compiled out of non-Editor call sites.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • hatayama/unity-cli-loop#1283: Prior PR that edits the same uloop-wait-for-debug-break skill documentation and restructuring of workflow/marker placement and safety notes.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose of documentation updates and user impact of the clarified guidance.
Title check ✅ Passed The title clearly identifies the main change as a clarification/improvement to debug-break guidance documentation across multiple skill documentation files.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/improve-skill

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@hatayama hatayama changed the title chore: Improve wait-for-debug-break skill guidance fix: Improve wait-for-debug-break skill guidance Jun 6, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 1 file

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="Packages/src/Editor/CliOnlyTools~/PausePoint/Skill/SKILL.md">

<violation number="1" location="Packages/src/Editor/CliOnlyTools~/PausePoint/Skill/SKILL.md:29">
P2: The new simulate-* guidance omits required Input System prerequisites (`com.unity.inputsystem` and Active Input Handling set to `Input System Package (New)` or `Both`), so the documented workflow can fail in otherwise valid projects.

(Based on your team's feedback about scoping simulate-* guidance to New Input System projects and documenting required Input Handling/package prerequisites.) [FEEDBACK_USED].</violation>
</file>

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

```

5. Trigger the behavior, such as `simulate-keyboard`, `simulate-mouse-input`, UI interaction, or dynamic code.
5. Trigger the behavior with `simulate-keyboard`, `simulate-mouse-input`, UI interaction, dynamic code, or similar commands.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: The new simulate-* guidance omits required Input System prerequisites (com.unity.inputsystem and Active Input Handling set to Input System Package (New) or Both), so the documented workflow can fail in otherwise valid projects.

(Based on your team's feedback about scoping simulate-* guidance to New Input System projects and documenting required Input Handling/package prerequisites.) .

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At Packages/src/Editor/CliOnlyTools~/PausePoint/Skill/SKILL.md, line 29:

<comment>The new simulate-* guidance omits required Input System prerequisites (`com.unity.inputsystem` and Active Input Handling set to `Input System Package (New)` or `Both`), so the documented workflow can fail in otherwise valid projects.

(Based on your team's feedback about scoping simulate-* guidance to New Input System projects and documenting required Input Handling/package prerequisites.) .</comment>

<file context>
@@ -38,7 +26,7 @@ uloop enable-debug-break --id player-jumped --timeout-seconds 30

-5. Trigger the behavior, such as simulate-keyboard, simulate-mouse-input, UI interaction, or dynamic code.
+5. Trigger the behavior with simulate-keyboard, simulate-mouse-input, UI interaction, dynamic code, or similar commands.
6. Wait for the marker:

</file context>


</details>

```suggestion
5. Trigger the behavior with `simulate-keyboard` or `simulate-mouse-input` (for projects using the New Input System with `com.unity.inputsystem` installed and Player Settings → Active Input Handling set to `Input System Package (New)` or `Both`), UI interaction, dynamic code, or similar commands.

hatayama added 5 commits June 6, 2026 11:25
Regenerate the checked-in Claude and Agents skill copies from the source skill so the installed guidance matches the package skill definition.
@hatayama hatayama changed the title fix: Improve wait-for-debug-break skill guidance chore: Clarify transient debug-break guidance Jun 6, 2026
@hatayama hatayama changed the title chore: Clarify transient debug-break guidance fix: Clarify transient debug-break guidance Jun 6, 2026
@hatayama
hatayama merged commit 476b2da into v3-beta Jun 6, 2026
5 checks passed
@hatayama
hatayama deleted the feature/improve-skill branch June 6, 2026 13:50
@github-actions github-actions Bot mentioned this pull request Jun 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant