vailabel/vailabel-studio

docs: Add a "Troubleshooting / Common Setup Issues" section to the README

开放

#240 创建于 2026年6月19日

 (0 条评论) (0 个反应) (0 位负责人)TypeScript (22 个派生)auto 404
documentationgood first issuehacktoberfest

仓库指标

星标
 (62 个星标)
PR 合并指标
 (平均合并 6天 18小时) (30 天内合并 9 个 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 ## 🩹 Troubleshooting section near the end of the Development section.

Steps

  1. Fork and branch: git checkout -b docs/readme-troubleshooting.
  2. Add a ## 🩹 Troubleshooting section 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.quarantine workaround (cross-link the Download note).
    • Python runtime not found — short note + link to #238.
  3. Run yarn lint.
  4. Commit docs: add troubleshooting section to README and open a PR.

Acceptance criteria

  • README has a Troubleshooting section with at least the four items above.
  • yarn lint passes.

Good first issue — comment here if you'd like to take it.

贡献者指南