Skip to content

feat: add Appium troubleshooting skill#13

Merged
KazuCocoa merged 5 commits into
appium:mainfrom
JustasMonkev:feat/appium-troubleshooting-skill
Mar 20, 2026
Merged

feat: add Appium troubleshooting skill#13
KazuCocoa merged 5 commits into
appium:mainfrom
JustasMonkev:feat/appium-troubleshooting-skill

Conversation

@JustasMonkev

@JustasMonkev JustasMonkev commented Mar 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • refine appium-troubleshooting to stay in one driver path and start from the failing symptom instead of a broader classification flow
  • trim the troubleshooting references into compact entry points that defer to official Appium docs first and keep a short community-search fallback for recurring cases
  • update README.md and AGENTS.md so the troubleshooting workflow stays aligned with the driver-scoped behavior

Checks

  • git diff --check
  • manual scenario validation against the updated troubleshooting skill for:
    • UiAutomator2 socket hang up on Android 14 emulator
    • unknown-driver session creation failure
    • XCUITest real-device WebDriverAgent timeouts right after session start

All three scenario checks stayed in the correct driver path and reached a concrete next step without cross-driver drift.

Closing #9

@KazuCocoa

Copy link
Copy Markdown
Member

What kind of checks/tests did you do complete with this skills? Could you add these in this description?

@KazuCocoa

Copy link
Copy Markdown
Member

Also, could you let AI tools to follow existing skill's format like adding metadata

@KazuCocoa KazuCocoa left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you split this PR into only for uia2, xcuitest etc so we can take a look at the individual driver basis

Comment thread skills/appium-troubleshooting/references/community-search.md
Comment thread skills/appium-troubleshooting/SKILL.md Outdated
Comment thread skills/appium-troubleshooting/SKILL.md
Comment thread skills/appium-troubleshooting/references/xcuitest-troubleshooting.md Outdated
@JustasMonkev

Copy link
Copy Markdown
Contributor Author

What kind of checks/tests did you do complete with this skills? Could you add these in this description?

I used this prompt

Act as the troubleshooting assistant under test. Base your responses on the current skill at /skills/appium-troubleshooting/SKILL.md and its references. Do not edit files.

Answer these three user scenarios exactly as the assistant would.

Scenario 1:
"My Android test on UiAutomator2 starts the app and then Appium throws socket hang up a few seconds later. I’m on Android 14 emulator. What should I do?"

Scenario 2:
"I’m not sure which driver is in use. The session just fails and the only thing I know is Appium says it can’t create a session. How do I troubleshoot it?"

Scenario 3:
"My iPhone real-device XCUITest run fails because WebDriverAgent builds, then commands start timing out right after session start. What should I check first?"

For each scenario, give the answer you would send to the user: concise but concrete, evidence-first, and aligned with the skill. Label them Scenario 1/2/3.

@JustasMonkev

Copy link
Copy Markdown
Contributor Author

Could you split this PR into only for uia2, xcuitest etc so we can take a look at the individual driver basis

yes, I will do it

@KazuCocoa KazuCocoa left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

After reading this PR again, I wondered if we should minimize skills documentation to avoid unnecessary duplication for long term maintenance

Comment thread skills/appium-troubleshooting/SKILL.md Outdated
Comment thread skills/appium-troubleshooting/SKILL.md Outdated
Comment thread skills/appium-troubleshooting/SKILL.md
Comment thread skills/appium-troubleshooting/SKILL.md Outdated
@JustasMonkev

Copy link
Copy Markdown
Contributor Author

Thanks for the detailed feedback! I have a tight schedule at the moment, so it may take me a couple of weeks to properly address all the comments — especially the structural questions around minimizing the skill docs. I'll get back to this as soon as I can.

@KazuCocoa KazuCocoa left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you! LG. This kind of guide will keep modifying/refined but it is helpful to put as the first step

@KazuCocoa KazuCocoa merged commit 7b0095b into appium:main Mar 20, 2026
2 checks passed
@KazuCocoa

Copy link
Copy Markdown
Member

Hi @JustasMonkev, congrats: the Appium project wants to compensate you for this contribution! Please reply to this comment mentioning @jlipps and @KazuCocoa and sharing your OpenCollective account name, so that we can initiate payment! Or let us know if you decline to receive compensation via OpenCollective. Thank you!

@JustasMonkev

Copy link
Copy Markdown
Contributor Author

Hi @JustasMonkev, congrats: the Appium project wants to compensate you for this contribution! Please reply to this comment mentioning @jlipps and @KazuCocoa and sharing your OpenCollective account name, so that we can initiate payment! Or let us know if you decline to receive compensation via OpenCollective. Thank you!

Hey, @KazuCocoa @jlipps, the account profile
https://opencollective.com/justas1

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.

2 participants