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

Improve accuracy of language #591

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from

Conversation

@caseyyoungflesh
Copy link
Contributor

@caseyyoungflesh caseyyoungflesh commented Jan 27, 2019

Originally statement:
"Create a new Git repository on your computer called bio."

Technically, I don't think the Git repository has a name on the local machine (though maybe others disagree) - rather there is a repository in a directory called 'bio' (however, on Github I would definitely say the repo has a name). Changed language in the exercise to reflect this.

@munkm
Copy link
Member

@munkm munkm commented Mar 8, 2019

Hi @caseyyoungflesh! Thanks so much for your PR and your thoughts about the wording here. I'd like other maintainers to weigh in since this is a bit subtle, but I'm not entirely sure that I agree with this change. I agree that in a local directory structure the repository lives inside the bio folder. However, if we're dealing with any remote we'd say that we're cloning/dealing with the bio repository (e.g on the remote server myserver we'd clone the bio repository with myserver/bio.git). The difference in this language could be confusing to new learners, and distinguishing why what a repository is called locally vs. remotely is different is probably too advanced for the lesson.

That said, I like that you distinguish the creation of a new directory/folder and the initialization of the repository on line 736 as two separate actions. I would be willing to merge that, but not the modified title of the exercise.

@caseyyoungflesh
Copy link
Contributor Author

@caseyyoungflesh caseyyoungflesh commented Mar 13, 2019

@munkm makes sense! I could definitely see the argument for changing the text but not the title.

@kekoziar
Copy link
Contributor

@kekoziar kekoziar commented May 2, 2019

Hi, @caseyyoungflesh, thanks for the PR. I agree with what @munkm wrote regarding this proposed change, especially the need to avoid confusing new learners. When I refer to a repository on my local machine, it is by the folder name; to me, they are one and the same regardless of if I have connected my local repo with a remote.

Other questions we might ask are, are the learners at a sufficient place to understand that when someone asks to create a bio repository, it is a two step process (folder creation then repo init); and is the knowledge that it is a two step process something we as instructors want the exercise to assess? As the exercise is now written, it assesses whether the learners understand that creating a repo is a two step process (or that the repo needs to be in a folder), while the rewrite lists the individual steps and only assesses if the learners recall the specific commands. I prefer assessing if learners can implement the process rather than memory recall of commands.

@caseyyoungflesh
Copy link
Contributor Author

@caseyyoungflesh caseyyoungflesh commented May 3, 2019

@kekoziar I see where you're coming from here. I find the existing language more confusing than helpful (likely because of my mental map of all of this), but fully understand that I might be in the minority!

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

Successfully merging this pull request may close these issues.

None yet

3 participants