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

Episode 3 suggests to use git status before initializing a repo, but does not show that #685

Open
jdvorak001 opened this issue Aug 14, 2019 · 4 comments

Comments

@jdvorak001
Copy link

@jdvorak001 jdvorak001 commented Aug 14, 2019

In a solution to a challenge in Episode 3 we say it would be good practice to check the status of the current directory just before issuing git init. But this practice is not actually shown in the lesson.

As a side-effect, the lesson actually introduces git status without being explicit about it.
I find this a bit underhands.

@jdvorak001
Copy link
Author

@jdvorak001 jdvorak001 commented Aug 14, 2019

And also, Episode 4 first uses git status in a context where it says "If we check the status of our project again".
I believe we should admit that we are introducing git status in Episode 3 already.

Loading

jdvorak001 added a commit to jdvorak001/git-novice that referenced this issue Aug 14, 2019
…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
@Sipley
Copy link

@Sipley Sipley commented Jan 15, 2020

I agree. The solution to "Places to Create Git Repositories" is a little confusing because the command git status doesn't give the output shown for the example as given. Suggestion: either move "if it looks like the following, you are good to go to create a new repository" earlier in the lesson when introducing git init or change to "if git status returns the following, it's best to avoid creating a new repository to be sure there is no conflicting repository in the directory". Alternatively, maybe combine the "Places to Create Git Repositories" and "Correcting git init Mistakes" sections, emphasizing the solution for the latter & highlighting the solution for the former as a useful tip?

Loading

@jdvorak001
Copy link
Author

@jdvorak001 jdvorak001 commented Jan 15, 2020

@Sipley, thanks for your comments. I suggested a solution to this issue in my pull request #686, which I have just updated with the latest gh-pages contents. Do you think the changes I suggested there could do the job, or should we try to refactor more?

Loading

@Sipley
Copy link

@Sipley Sipley commented Jan 16, 2020

If I understood the changes correctly, yes! I think those are great!

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants