rokucommunity / rokucommunity/vscode-brightscript-language

Add "getting started" walkthrough for new users and project scafolding

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

Nobody has claimed this yet.

enhancement good first issue
Dominant language
TypeScript
Stars
132
Forks
60
Avg merge
13h 53m
Merged PRs (30d)
20

Description

VSCode supports "getting started" walkthroughs on their welcome page. We should add our own that helps devs:

  • learn how to use the extension
  • set up launch.json and bsconfig.json
  • scaffold new projects with typical roku structure

You can follow the sample here on how to contribute a walkthrough:
https://github.com/microsoft/vscode-extension-samples/blob/32c5dda0d58a9d92952498e8934e574f1e099ff0/getting-started-sample/package.json#L39

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 by reviewing the linked VS Code getting-started sample, especially its package.json walkthrough contribution. Then inspect this extension's existing project structure and configuration entry points; done means a welcome-page walkthrough teaches extension use, launch.json and bsconfig.json setup, and typical Roku project scaffolding.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.