vailabel/vailabel-studio
在 GitHub 查看docs: Add a "Troubleshooting / Common Setup Issues" section to the README
Open
#240 创建于 2026年6月19日
documentationgood first issuehacktoberfest
仓库指标
- Star
- (62 star)
- PR 合并指标
- (PR 指标待抓取)
描述
Summary New contributors keep hitting the same setup snags. Collect them into one Troubleshooting section in the README so people can self-serve.
Where
README.md— add a## 🩹 Troubleshootingsection near the end of the Development section.
Steps
- Fork and branch:
git checkout -b docs/readme-troubleshooting. - Add a
## 🩹 Troubleshootingsection covering:- Tauri prerequisites per OS — link https://tauri.app/start/prerequisites/ and list common Linux packages (
webkit2gtk,librsvg). - Wrong Node/Yarn version — Node 20+ and Yarn Classic (v1); how to check (
node -v,yarn -v). - macOS "app is damaged / unidentified developer" — the
xattr -dr com.apple.quarantineworkaround (cross-link the Download note). - Python runtime not found — short note + link to #238.
- Tauri prerequisites per OS — link https://tauri.app/start/prerequisites/ and list common Linux packages (
- Run
yarn lint. - Commit
docs: add troubleshooting section to READMEand open a PR.
Acceptance criteria
- README has a Troubleshooting section with at least the four items above.
yarn lintpasses.
Good first issue — comment here if you'd like to take it.