github-samples / github-samples/pets-workshop

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

Open
#258 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

priority: P1
Dominant language
Python
Stars
80
Forks
161
Avg merge
31m
Merged PRs (30d)
1

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with app/client/package.json, content/1-hour/README.md, and content/1-hour/0-setup.md; compare the declared runtimes and the Bash and PowerShell setup paths. Run setup using each documented shell path, including start-app.ps1, and confirm the prerequisites, runtime versions, and Windows guidance match what works.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash, node.js, powershell, python
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.