Shopify / Shopify/shopify-app-template-node

Task: Add 'How to debug' section to the README file.

Open
#1,128 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Stale
Dominant language
JavaScript
Stars
1k
Forks
434
PR merge metrics
No merged PRs in 30d

Description

Task

Add documentation on how to debug the app locally.

Add for example a .vscode/launch.json file that people can use to run the app instead of running npm run dev.

For now, there is no way for a newcomer to debug their code.

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 the README and the existing npm run dev workflow described in the issue. Add a How to debug section and a usable .vscode/launch.json example for local debugging; done means a newcomer can follow the README and launch the app without relying only on npm run dev.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js, vscode
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.