github-samples / github-samples/pets-workshop

1-hour workshop: Specify supported runtimes and align cross-platform prerequisites

Aperta
#258 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

priority: P1
Lingua principale
Python
Stelle
80
Fork
161
Merge medio
31m
PR unite (30g)
1

Descrizione

Problem

content/1-hour/README.md requires only a "recent" Node.js and Python version. The current Astro dependency requires Node.js >=22.12.0, but this requirement is not declared in app/client/package.json or stated in the workshop. The same prerequisite section says a Bash-capable shell is required and tells Windows learners to install WSL or Git Bash, while content/1-hour/0-setup.md provides a native PowerShell startup path.

A learner can satisfy the written prerequisites and still fail during setup, or install an unnecessary shell on Windows.

Suggested change

Declare and document supported runtime versions, and describe Bash and PowerShell as alternative setup paths.

Acceptance criteria

  • app/client/package.json declares the supported Node.js engine.
  • The one-hour prerequisites state a concrete Node.js minimum or supported LTS release and a tested Python range.
  • Native Windows learners are told that PowerShell is sufficient when using start-app.ps1.
  • Bash/WSL guidance is limited to the Bash script path.
  • Setup is tested using each documented shell path.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da app/client/package.json, content/1-hour/README.md e content/1-hour/0-setup.md; confronta i runtime dichiarati e i percorsi di configurazione di Bash e PowerShell. Esegui la configurazione usando ogni percorso di shell documentato, incluso start-app.ps1, e verifica che i prerequisiti, le versioni dei runtime e le indicazioni per Windows corrispondano a ciò che funziona.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
bash, node.js, powershell, python
Ambito
developer-experience, documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Attiva
Chiarezza
Specificata chiaramente
Idoneità per principianti
78/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.