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

Make it clear that git status is introduced in Episode 3 (issue #685) #686

Closed

Conversation

jdvorak001
Copy link
Contributor

@jdvorak001 jdvorak001 commented Aug 14, 2019

I am suggesting this fix to issue #685.

jdvorak001 and others added 2 commits August 14, 2019 06:54
…pentry#685)

- actually teach the good practice of running ``git status`` before ``git init`` to avoid nested repositories
- be clear that ``git status`` is introduced in Episode 3, not 4
- show the contents of a .git sub-directory
- minor re-wordings in Episode 3
@munkm
Copy link
Contributor

munkm commented Jan 16, 2020

Hey @jdvorak001 thanks for the review request! I'm sorry it's taken a bit to get to your PR. I'll do my best to get to it this week!

Copy link
Contributor

@kekoziar kekoziar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that starting with explaining nested repositories is the best introduction to Git for new learners. It seems like they should first learn out to initialize a repository and what that means, then a little later have them do a thought experiment as to what should be made into repositories.

@jdvorak001
Copy link
Contributor Author

Thanks for the review. It certainly is not the intent of this path to explain nested repositories, let alone promote them. It just warns against them (as does the currently released version). What I tried to plant is the good practice of running git status before git init. With that, the git status command is introduced a little.

Copy link
Contributor

@kekoziar kekoziar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR basically moves the "Places to Create Git Repositories" exercise into the lesson prior to learners first initializing a repository. I don't agree with the change because learners do not have the framework of initializing repositories on which to add the concept of nested repositories.


It is good practice to first check if this is a good place to do so:
a new repository shall not be nested in another repository placed higher up the directory hierarchy.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this sentence introduces topic of nested repositories. Learners will ask, "what does that mean" and "why shouldn't we do that" which is explained later in the lesson.

@kekoziar
Copy link
Contributor

I'm going to close this PR in preparation of the new workbench lesson architecture, but with the following points which halted the original merging of this PR.

PRs should be limited to one issue per PR. This PR attempted to do many things, and so the original issue - introducing git status at the very beginning - was lost and never implemented. I happen to tell learners that if they need to remember only one thing, it's git status. I absolutely agree with and approve moving it to prior to git init with explanation. However, there were questions about the other content that was added to the PR. Please submit issues as separate PRs in the future.

@kekoziar kekoziar closed this Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants