coderoad/coderoad-vscode

Fix git config error

Opened this issue · 2 comments

jcandan commented

Describe the bug

A clear and concise description of what the bug is.

To Reproduce

Steps to reproduce the behavior:

  1. Open VSCode into a blank folder
  2. Run CodeRoad: Start
  3. Choose File, and upload a tutorial.json file
  4. Hit Start on the tutorial
  5. See the Git Config Error page
  6. Open terminal, and in this empty project folder, run git init
  7. Click Check Again
  8. Refreshes, but the error is still there.
  9. Close the VSCode window.
  10. Re-open the project folder.
  11. Run CoadRoad: Start

At this point, the first lesson is visible

Expected behavior

The instructions don't say anything about having to run git init.

Either, update the instructions in plugin documentation and website, or prevent the error from blocking usage.

Screenshots

Image

Image

Image

Image

Image

Image

Desktop (please complete the following information):

  • Platfrom: Windows 11 Version 23H2 (OS Build 22631.2861)
  • OS: Ubuntu via WSL2
  • Version 24.04.1

Node (please complete the following information):

  • Version v20.18.2

Git (please complete the following information):

  • Version 2.43.0

Additional context

N/A

jcandan commented

This ticket, in conjunction with #629, may need a title and scope adjustment.

There are a couple conflicting items in play here:

  • Must be an empty folder
  • Must be a git project

Additionally documented above is: the Check Again button is not working.

jcandan commented

Here are the steps to actually get a working tutorial locally.

  1. Open an empty folder in VS Code
    mkdir empty-project1
    code empty-project1
  2. Run "CodeRoad: Start" from the Command Pallete.
  3. Click "Start New Tutorial"
  4. Choose URL, and supply a tutorial.json URL (e.g. https://raw.githubusercontent.com/.../refs/heads/main/tutorial.json)
  5. Open terminal, and in this empty project folder, run git init.
  6. Click "Start" at the bottom of the tutorial window