microsoft / microsoft/vscode-dwarf-debugging-ext

Improve documentation

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
26
Forks
6
PR merge metrics
No merged PRs in 30d

Description

The details of how this extension is supposed to work are unclear. I would appreciate more documentation on this. For example:

  • Can the extension work in concert with the DWARF debugging Chrome extension? (Similarly as to how a JS breakpoint will be hit in Chrome devtools and VSCode all at once)

  • Should I make sure the Chrome extension is installed?

  • Should I make sure it is not installed?

  • How well does the extension work with multiple threads (web workers)? For example I'm observing a situation where my C++ sources are only displayed in Loaded Scripts view in one thread out of several.

Contributor guide

No contributing guide indexed for this repository

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

No files or tests are named. Start by reviewing the extension's existing documentation and its behavior with the DWARF debugging Chrome extension and multiple web-worker threads. Done means documenting installation guidance, extension interaction, and the observed multi-threaded Loaded Scripts behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, javascript, vscode, wasm
Domain
devtools, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.