Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add git init step #629

Open
jcandan opened this issue Feb 5, 2025 · 1 comment
Open

Add git init step #629

jcandan opened this issue Feb 5, 2025 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@jcandan
Copy link

jcandan commented Feb 5, 2025

Is your feature request related to a problem? Please describe.

To run a CodeRoad tutorial, the documentation instructs you to open an empty project.

If the folder already contains a .git/ directory, the tutorial errors after hitting Start.

If you forget to git init, the tutorial will silently fail.

Describe the solution you'd like

We could either:

  • Update documentation to account for the need to run git init in the steps leading up to running a tutorial.
  • Allow .git/ directory to exist when opening an empty folder.
  • Automatically check whether git is instantiated in a folder and run git init if it is not.

Describe alternatives you've considered

TBD

Additional context

@jcandan
Copy link
Author

jcandan commented Feb 10, 2025

Of the SelectTutorial forms, selecting a tutorial via the TutorialSelect dropdown captures all of the project files from the tutorial, including their .git/ folder, circumventing this issue. But the File and URL options require the user to git init before they initiate the tutorial with the Start button.

We really should document this in the UI and documentation, or allow .git/ directory to exist when firing up CodeRoad--however, I could see the latter being problematic for the same reasons described in #627.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants