Skip to content
This repository was archived by the owner on Feb 18, 2025. It is now read-only.
This repository was archived by the owner on Feb 18, 2025. It is now read-only.

Revise Chapter 4 - Staying Synchronized #92

@braughtg

Description

@braughtg

The following updates should be made to Chapter 4:

  • - 4.1.1.c - convert to MC with a hint.
  • - 4.1.2.a - can we ask a MC question here about the page they see?
  • - 4.1.2.b - convert to MC with a hint.
  • - 4.2 - Seems like we should ask a question or two about the diagram in this section. Mabye these:
    • Which action copies changes from the upstream to your local repository?
    • Which action copies changes from your local repository to your origin repository?
  • - 4.3.1 - Revise to use the deep quick start link to the codespace here. See the "Open Questions" issue for the link to use. Also, include the image DevEnv-Kitty-Ready.png from source/shared-images here to show them what to expect. See the "Conceptual Overview" document for the code to use to add the image.
  • - 4.3.2.b - revise question text to be more clear. Maybe... "Examine the output of the git remote -v command from Task 4.3.2.a." Then maybe two questions?
    • Is the URL for the origin remote in the main project GitHub space or in your GitHub space?
    • Where does this remote appear in Figure 4.1.1? (lower left, upper left, upper right)?
  • - 4.3.2.c - add reg exp to check that upstream URL is valid.
  • - 4.3.2.d - use git remote (code font) for the command in the question statement.
  • - 4.3.2.e - ask MC about how the output confirms that the new remote has been added.
  • - 4.3.2.f - revise similarly to 4.3.2.b.
  • - 4.4 - Add a short explanation of what they are about to do and include modified Figure 4.2.1 with just the "Pull" arrow present.
  • - 4.4 - Questions should be numbered 1, 2, 3, 4... instead of sub parts (a,b,c,...) since there is no question 2.
  • - (current) 4.4.1.a - becomes 4.4.1 - this could have two answers git status or git branch. Both were used in a prior chapter to check the active branch. Should we include both? Or should we just ask "Which command could you use?" instead of "Which command did you use?"
  • - (current) 4.4.1.b - becomes 4.4.2 - "in" should be "is" in the question statement.
  • - (current) 4.4.1.c - becomes 4.4.3 - Shorten the command to git pull --ff-only <remote> <branch>. Add a reminder that <branch> can be a name like origin. Instead of "use the git pull command above..." maybe "modify the git pull command above .." and ask a fill in that uses a reg ex to verify format.
  • - (current) 4.4.1.d - becomes 4.4.4 - ask them to use the command from (new) 4.4.3 and examine the output. It should refer to (new) 4.4.3 instead of 4.4.1.b. Also double check the options and answers given here.
  • - 4.5.1 - "main" should be main.
  • - 4.5.1.a - switch to shortened version git push <remote> <branch>. Ask fill in for the command with regex to check the format and that it contains origin as the <remote>. Move instruction to use the command to 4.5.1.b.
  • - 4.5.1.b - Give instruction to use the command from 4.5.1.a. Also double check the options and the answers here.
  • - 4.6.1.a - make this a parson's problem to make the main branch the active branch and confirm that it is. Give the right commands along with a few distractors as tiles in the parsons problem. Use git branch as the command to confirm to support 4.6.1.b.
  • - 4.6.1.c - shorten command to git branch -D <branch> and introduce it as it is now, then ask fill in question for the command they will use for their branch. Check the format with reg ex.
  • - 4.6.1.d - Instruct them to use the command from 4.6.1.c. Asks MC about the output. The output should be something like "Deleted branch (was 09ca29c)" One alternative should be "error; branch '' not found. Give a hint that refer them back to 4.6.1c if they see an error.
  • - 4.6.2 - Swap questions a and b.
    • 4.6.2.a - ask MC about how you could check if the branch exists in your origin repo.
    • 4.6.2.b - ask the TF about whether the branch exists.
  • - 4.6.2.c
    • Shorten command to git push -d <remote> <branch>
    • Ask fill in question for the command and use reg ex to check format.
  • - 4.6.2.d - Instruct them to run command and ask MC question about the output. The output should be - [deleted] <branch>. If they get an error: unable to delete '<branch>': remote ref does not exist suggest they check the branch name and that branch exists in remote repo (see 4.6.2.a)
  • - (new) 4.6.2.e - Refer them to 4.6.2.a and instruct them to confirm that the branch has been deleted from the origin. If they find that it has not been deleted, refer them back to 4.6.2.c to try again.
  • - 4.7.1 - the options on the left are overrunning the space and getting cut off.
    • Use shortened options from the text for:
      • git remote add <remote> <URL>
      • git push <remote> <branch>
      • git push -d <remote> <branch>
      • git pull --ff-only <remote> <branch>
  • - 4.8 - There are extra headings appearing here (e.g. 4.8.1.1) and the question numbering is running for the full page rather than by sub-sections. Edits below will change the structure of this section so this should resolve itself.
  • - move the parson's problem 4.8.2 to the top making it 4.8.1 and add "claim an issue" as a step and add a hint. This gets them to think through the full process.
  • Add new subsections as follows:
    • - (new) 4.8.1 - Claim Round 2 Issue
      • (new 4.8.1.1) - is the (current) 4.8.1.a - add a hint.
      • (new 4.8.1.2) - is the (current) 4.8.1.b and but make it a MC with the issue numbers and titles all valid Round 2 issues should be accepted as correct. Include a few distractors.
    • - (new) 4.8.2 - Fix the Issue
      • (new 4.8.2.1) - is the (current) 4.8.3.a.
      • (new 4.8.2.(2,3) - (current) 4.8.3 (b,c) with changes to have an option for each of the issues (e.g. a good branch aname for each round 2 issue, plus some distractors. Then accept as correct all options that are not distractors.
    • - (new) 4.8.3 - Upstream the Changes
      • (current) 4.8.4.a - delete this question.
      • (new) 4.8.3.1 - is (current) 4.8.4.b with a reg ex to check link.
      • (new) 4.8.3.2 - convert the (current) 4.8.4 (c,d) into to a select all
        • Look at the base and head repositories listed in the PR. Which of the following statements are true:
          • The base repository is the upstream repository.
          • The base repository is my origin repository.
          • The base repository is my local repository.
          • The head repository is ... (etc.)
      • (new) 4.8.3.3 - convert (current) 4.8.4 (e,f) into a matching:
        • base branch -> upstream 'main' branch
        • compare branch -> feature branch in your origin repo
      • (new) 4.8.3.4 - is (current) 4.8.4.g but MC with any line number that would be changed for any Round 2 issue accepted as correct. Clarify hint to look at the diff in GitHub and refer to section 3.8.4.
      • (new) 4.8.3.5 - is (current) 3.8.5 - change to MC or select all question with possible explanations for how this might create a problem when maintainers begin to merge PRs.
    • - The last two questions in 4.8.3 (now 4.8.4) need correct answers/feedback and hints.
    • - The let's do it all again section has an extra tag at the end that must be removed.

Metadata

Metadata

Labels

Ch4Issue related to Chapter 4 - Staying Synchronized

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions