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

Update 07-github.md #830

Closed
wants to merge 1 commit into from
Closed

Conversation

annajiat
Copy link
Contributor

  1. Updated challenge title to match with the challenge itself.
  2. In case of the learner facing the same problem due to another reason e.g. adding another file from the web interface, the solution can now be located using the web browser's find feature CTRL+F, instead of being hidden away in the collapsed solution.

Proposed:

Fixing "refusing to merge unrelated histories" in relation to GitHub License and README files

Current:

GitHub License and README files

1) Updated challenge title to match with the challenge itself.
2) In case of the learner facing the same problem due to another reason e.g. adding another file from the web interface, the solution can now be located using the web browser's find feature CTRL+F, instead of being hidden away in the collapsed solution.

Proposed:
> ## Fixing "refusing to merge unrelated histories" in relation to GitHub License and README files

Current:
> ## GitHub License and README files
@@ -443,7 +443,7 @@ GitHub, though, this command would download them to our local repository.
> {: .solution}
{: .challenge}

> ## GitHub License and README files
> ## Fixing "refusing to merge unrelated histories" in relation to GitHub License and README files
Copy link
Contributor

Choose a reason for hiding this comment

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

The episode already refers to the title of this challenge

See the “GitHub License and README files” exercise below for a full explanation of why the repository needs to be empty.

I don't see how this is an improvement. If a novice learner is walking through this, they will not encounter the situation you described.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for reviewing.

There could be various reasons for encountering it. During the workshop the note may be missed perhaps due to being in between two large screenshots or more importantly while the learners are reviewing the materials after the workshop, they might not be able to locate "refusing to merge unrelated histories" by searching for it in the lesson. The web browser's search (CTRL+F or Cmd+F) does not work because the solution of exercise needs to be expanded first.

Alternatively, we could add the following line to the note so that CTRL+F works and also highlight the note:
to avoid the error "refusing to merge unrelated histories"

So, it will look like:
Note: Since this repository will be connected to a local repository, it needs to be empty. Leave “Initialize this repository with a README” unchecked, and keep “None” as options for both “Add .gitignore” and “Add a license” to avoid the error "refusing to merge unrelated histories". See the “GitHub License and README files” exercise below for a full explanation of why the repository needs to be empty.

Should we go ahead with this alternative?

Additionally, we may also choose to make it a yellow callout to further highlight it and for the ease of referring to it during the workshop via the link to the callout.

@scottgruber
Copy link
Contributor

Hi, I'm a new maintainer to this repository and reviewing pull requests and issues. If I follow this thread correctly, the maintainer makes a point that the novice learners wouldn't encounter the situation described. I'll close this PR, however @annajiat if you have any further comments please reopen this PR.

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.

None yet

3 participants