vailabel/vailabel-studio

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

Open

#240 ouverte le 19 juin 2026

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)TypeScript (22 forks)auto 404
documentationgood first issuehacktoberfest

Métriques du dépôt

Stars
 (62 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Ouvrez le fichier README.md, localisez la section Développement et ajoutez une nouvelle sous section `## Dépannage` avec les quatre points listés dans l'issue (prérequis Tauri, version Node/Yarn, contournement de la quarantaine macOS, note sur le runtime Python). Faites des références croisées aux notes existantes le cas échéant. Exécutez `yarn lint` pour vérifier que la modification est propre.
Stack technique
typescriptnodejs
Domaine
documentationdeveloper experience
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90