[Repo Assist] docs: add Troubleshooting section to README#96
Draft
github-actions[bot] wants to merge 1 commit intomasterfrom
Draft
[Repo Assist] docs: add Troubleshooting section to README#96github-actions[bot] wants to merge 1 commit intomasterfrom
github-actions[bot] wants to merge 1 commit intomasterfrom
Conversation
Cover the most-reported user pain points: - Extension does nothing / no debug output - phpcbf.onsave not formatting on save - 'No formatter' message / selecting default formatter - Coding standard not found - Relative executablePath not persisting after restart These scenarios collectively account for a large share of open issues (#8, #21, #34, #35, #36, #39, #43) and are not currently documented. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced Mar 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 This PR was created by Repo Assist, an automated AI assistant.
Summary
Adds a Troubleshooting section to the README covering the five most-reported user pain points. The section is placed just above "Known Issues" so it's easy to find.
Motivation
A large share of the open issues (#8, #21, #34, #35, #36, #39, #43) follow the same patterns: "it does nothing", "onSave doesn't work", or "standard not found". None of these scenarios are currently documented, so users have no self-service path before opening an issue.
What's covered
phpcbf.onsavenot formatting on saveexecutablePathstops working after restartTest Status
Documentation-only change — unit tests all pass (
npm run test:unit: 7/7).