Update README.md of existing exercises (#161)

VikramGoyal23 · web-flow · commit e1a84d730121 · 2025-12-15T19:38:50.000+08:00
# Exercise Review ## Exercise Discussion Fixes #160 ## Checklist - [ ] If you require a new remote repository on the `Git-Mastery` organization, have you [created a request](https://github.com/git-mastery/exercises/issues/new?template=request_exercise_repository.md) for it? - [ ] Have you written unit tests using [`repo-smith`](https://github.com/git-mastery/repo-smith) to validate the exercise grading scheme? - [X] Have you tested the download script using `test-download.sh`? - [X] Have you verified that this exercise does not already exist or is not currently in review? - [ ] Did you introduce a new grading mechanism that should belong to [`git-autograder`](https://github.com/git-mastery/git-autograder)? - [ ] Did you introduce a new dependency that should belong to [`app`](https://github.com/git-mastery/app)?
diff --git a/branch_bender/README.md b/branch_bender/README.md
@@ -1,49 +1 @@
-# branch-bender
-
-You are building the latest webapp with the coolest features like login, payments, and dashboard.
-
-## Task
-
-You have been working on all of these changes on separate branches and you now want to merge them all into `main`.
-
-### Task 1
-
-Merge the `feature/login` branch into `main` first. Make sure you do not use fast forwarding when merging!
-
-### Task 2
-
-Merge the `feature/dashboard` branch into `main` next.
-
-### Task 3
-
-Merge the `feature/payment` branch into `main` last.
-
-## Final state
-
-The final Git graph (using `git log --oneline --graph`) should look like this:
-
-```mermaid
-gitGraph
-commit
-branch feature/login
-checkout main
-branch feature/dashboard
-checkout main
-branch feature/payment
-checkout feature/login
-commit
-commit
-checkout main
-merge feature/login
-checkout feature/dashboard
-commit
-commit 
-commit
-checkout main
-merge feature/dashboard
-checkout feature/payment
-commit
-commit
-checkout main
-merge feature/payment
-```
+See https://git-mastery.github.io/lessons/merge/exercise-branch-bender.html
diff --git a/branch_delete/README.md b/branch_delete/README.md
@@ -1,12 +1 @@
-# branch-delete
-
-## Task
-
-You have two branches: `optimization-approach-1` and `optimization-approach-2` and you need to delete them!
-
-You decided to go ahead with `optimization-approach-1` so you merged it and you can delete the branch already.
-
-Since you don't need `optimization-approach-2`, you should delete it WITHOUT merging.
-
-1. Delete the `optimization-approach-1` branch
-2. Delete the `optimization-approach-2` branch safely
+See https://git-mastery.github.io/lessons/branchDelete/exercise-branch-delete.html
diff --git a/branch_forward/README.md b/branch_forward/README.md
@@ -1,19 +1 @@
-# branch-forward
-
-You are writing the outline for a story. You now have two parallel storylines in two branches.
-
-## Task
-
-1. Review the `with-sally` and `with-ginny` branches.
-2. Merge only the branch(es) that can be fast-forwarded into `main`.
-3. Leave other branches (if any) unmerged.
-
-## Hints
-
-<details>
-
-<summary>Hint 1</summary>
-
-Ensure you have switched to the destination branch before initiating the merge.
-
-</details>
+See https://git-mastery.github.io/lessons/merge/exercise-branch-forward.html
diff --git a/branch_rename/README.md b/branch_rename/README.md
@@ -1,7 +1 @@
-# branch-rename
-
-You have been working on the login feature for your application on the branch `login`. However, to keep things consistent across other branches, you need to rename it to `feature/login`.
-
-## Task
-
-Rename the `login` branch to `feature/login`.
+See https://git-mastery.github.io/lessons/branchRename/exercise-branch-rename.html
diff --git a/clone_repo/README.md b/clone_repo/README.md
@@ -1,8 +1 @@
-# clone-repo
-
-## Task
-
-1. Fork the repo <https://github.com/git-mastery/gm-shapes> to your GitHub account, if you haven't done so already. Retain the original repo name `gm-shapes`.
-1. Clone the fork to your computer, in to the folder `clone-repo/shapes` (note how the target folder is `shapes`, not `gm-shapes`).
-1. Set up a remote named `upstream`, to point to the git-mastery/gm-shapes repo.
-
+See https://git-mastery.github.io/lessons/clone/exercise-clone-repo.html
diff --git a/conflict_mediator/README.md b/conflict_mediator/README.md
@@ -1,12 +1 @@
-# conflict-mediator
-
-You have been called in mediate a conflict between two developers.
-
-John wants to change the script to print "Hello World!", while Josh wants to change the script to print "Hello Everyone!" and they cannot come to a compromise.
-
-## Task
-
-Try to merge Josh's branch (branch name `josh`) into `main`. You should encounter a merge conflict.
-
-Fix the merge conflict created by merging both John's and Josh's changes, setting the text to "Hello Everyone and World!" instead.
-
+See https://git-mastery.github.io/lessons/mergeConflicts/exercise-conflict-mediator.html
diff --git a/fetch_and_pull/README.md b/fetch_and_pull/README.md
@@ -1,14 +1 @@
-# fetch-and-pull
-
-## Task
-
-You have been given a clone of the `git-mastery/gm-shapes` repo.
-
-Another developer Alice's has created a remote copy of this repo at <https://github.com/git-mastery/gm-shapes-alice> which seems to have an additional commit in the `main` branch.
-
-Add that repo as a remote titled `alice-upstream`, and bring over Alice's additional commit to your repo.
-
-Alice's friend Bob has copied Alice's repo to <https://github.com/git-mastery/gm-shapes-bob>, and added one more commit.
-
-Add that repo as another remote titled `bob-remote`, and fetch (not pull or merge) his new commit to your repo.
-
+See https://git-mastery.github.io/lessons/pull/exercise-fetch-and-pull.html
diff --git a/fork_repo/README.md b/fork_repo/README.md
@@ -1,10 +1 @@
-# fork-repo
-
-<!--- Insert exercise description -->
-
-## Task
-
-Create a fork of the repo <https://github.com/git-mastery/gm-shapes> to your
-GitHub account.
-
-Retain the original repo name `gm-shapes`.
+See https://git-mastery.github.io/lessons/fork/exercise-fork-repo.html
diff --git a/grocery_shopping/README.md b/grocery_shopping/README.md
@@ -1,49 +1 @@
-# grocery-shopping
-
-You have been tasked to go grocery shopping for the week.
-
-Inside `shopping-list.txt`, you will find your shopping list items. As you walk around the grocery shop, you remove items from the shopping list that you found. You also notice that your shopping list is missing several things that you cannot find in the current grocery store, so you start adding to the shopping list.
-
-## Task
-
-Edit `shopping-list.md` and remove at least one item from the shopping list and add at least one new item to the shopping list.
-
-## Hints
-
-<details>
-
-<summary>Hint 1</summary>
-
-Have you removed at least one item from the shopping list?
-
-</details>
-
-<details>
-
-<summary>Hint 2</summary>
-
-Have you added at least one (new) item to the shopping list? This item must not have been in the original shopping list.
-
-</details>
-
-<details>
-
-<summary>Hint 3</summary>
-
-Not seeing your changes? Are you sure you have run `git add shopping-list.txt` and run `bash submit.sh`?
-
-</details>
-
-<details>
-
-<summary>Hint 4</summary>
-
-Try to change the file to:
-
-```md
-- Apples
-- Pears
-```
-
-</details>
-
+See https://git-mastery.github.io/lessons/commit/exercise-grocery-shopping.html
diff --git a/ignoring_somethings/README.md b/ignoring_somethings/README.md
@@ -1,17 +1 @@
-# ignoring-somethings
-
-You have stumbled upon a repository with an existing `.gitignore`. However, you
-have discovered that the `.gitignore` is not as accurate as you would like it to
-be.
-
-Some files are showing up when they should be hidden, and some files are hidden
-when they should be present.
-
-## Task
-
-1. While you wish to continue ignoring every file in the `many/` folder, you 
-    want to un-ignore just `many/file22.txt`
-2. `why_am_i_hidden.txt` should not be hidden
-3. `ignore_me.txt` should be hidden
-4. Hide the `runaway.txt` file in `this/`, however, you don't know how many 
-    layers of nesting it is under, so use the pattern matching syntax
+See https://git-mastery.github.io/lessons/ignore/exercise-ignoring-something.html
diff --git a/link_me/README.md b/link_me/README.md
@@ -1,9 +1 @@
-# link-me
-
-You have started working on a team project `link-me` but realized that you need
-to share your changes with your other team members.
-
-## Task
-
-Add the `git-mastery/link-me` repository as the `upstream` remote for the
-`link-this` repository.
+See https://git-mastery.github.io/lessons/setRemote/exercise-link-me.html
diff --git a/log_and_order/README.md b/log_and_order/README.md
@@ -1,8 +1 @@
-# log-and-order
-
-## Task
-
-You are tasked with tracking down a criminal who was on a crime spree and has managed to escape. He has hidden his crimes in his log which he stores Examine the revision graph of the given repo `many-commits` and answer the questions given in `answers.txt`. When the expected answer is a SHA, you may provide the full or the partial SHA (e.g., the first 7 characters of the SHA).
-
-Run `gitmastery verify` to check if your answers are correct.
-
+See https://git-mastery.github.io/lessons/log/exercise-log-and-order.html
diff --git a/merge_undo/README.md b/merge_undo/README.md
@@ -1,41 +1 @@
-# merge-undo
-
-Scenario: You are keeping notes on the characters of a play that you are writing. In the main story line (which is in the `main` branch), you introduced two characters, Rick and Morty. You had two other characters in two separate branches `daughter` and `son-in-law`. Just now, you introduced these two characters to the main story line by merging the two branches to the `main` branch.
-
-```mermaid
-gitGraph
-    commit id: "Add Rick"
-    commit id: "Add morty"
-    branch daughter
-    branch son-in-law
-    checkout daughter
-    commit id: "Add Beth"
-    checkout son-in-law
-    commit id: "Add Jerry"
-    checkout main
-    commit id: "Mention Morty is grandson"
-    merge daughter id: "Introduce Beth"
-    merge son-in-law id: "Introduce Jerry"
-```
-
-However, now you realise this is premature, and wish to undo that change.
-
-## Task
-
-Undo the merging of branches `son-in-law` and `daughter`.
-
-The result should be as follows:
-
-```mermaid
-gitGraph
-    commit id: "Add Rick"
-    commit id: "Add morty"
-    branch daughter
-    branch son-in-law
-    checkout daughter
-    commit id: "Add Beth"
-    checkout son-in-law
-    commit id: "Add Jerry"
-    checkout main
-    commit id: "Mention Morty is grandson"
-```
+See https://git-mastery.github.io/lessons/merge/exercise-merge-undo.html
diff --git a/mix_messy_docs/README.md b/mix_messy_docs/README.md
@@ -1,27 +1 @@
-# mix-messy-docs
-
-You are writing user documentation for a product. You have already written documentation for a few new features, each in a separate branch. You wish to accumulate this work in a separate branch called `development` until the next product release.
-
-## Task
-
-1. Create a new branch `development`, starting from the commit tagged `v1.0`
-2. Merge the `feature-search` branch onto the `development` branch, without using fast-forwarding (i.e., create a merge commit). Delete the `feature-search` branch.
-3. Similarly, merge the `feature-delete` branch onto the `development` branch. Resolve any merge conflicts -- in the `features.md`, the delete feature should appear after the search feature (see below). Delete the `feature-delete` branch.
-   ```
-   # Features
-
-   ## Create Book
-
-   Allows creating one book at a time.
-
-   ## Searching for Books
-
-   Allows searching for books by keywords.
-   Works only for book titles.
-
-   ## Deleting Books
-
-   Allows deleting books.
-   ```
-5. The `list` branch is not yet ready to be merged but rename it as `feature-list`, to be consistent with the naming convention you have been following in this repo.
-
+See https://git-mastery.github.io/lessons/branchDelete/exercise-mix-messy-docs.html
diff --git a/mix_messy_graph/README.md b/mix_messy_graph/README.md
@@ -1,20 +1 @@
-# mix-messy-graph
-
-You are writing user documentation for a product. You have already written documentation for a few new features, each in a separate branch. After merging the `feature-search` branch, you realise this way of merging can result in a complicated revision graph. Instead, you wish to merge these changes in a way that results in a simple linear revision graph.
-
-## Task
-
-1. Undo the merging of `feature-search`.
-2. Squash-merge the `feature-search` branch onto the `main` branch. Delete the `feature-search` branch.
-3. Similarly, squash-merge and delete the `feature-delete` branch, while resolving any merge conflicts -- in the `features.md`, the delete feature should appear after the search feature. 
-4. The `list` branch is not needed, as you have decided not to have that feature. Delete that branch.
-
-The resulting revision graph should be as follows:
-
-```mermaid
-gitGraph BT:
-  commit id: "Add features.md"
-  commit id: "Mention feature for creating books" tag: "v10"
-  commit id: "Add the delete feature"
-  commit id: "Add the search feature"
-```
+See https://git-mastery.github.io/lessons/branchDelete/exercise-mix-messy-graph.html
diff --git a/new-exercise.py b/new-exercise.py
@@ -100,24 +100,7 @@ def create_exercise_config_file(config: ExerciseConfig) -> None:
 def create_readme_file(config: ExerciseConfig) -> None:
     with open("README.md", "w") as readme_file:
         readme = f"""
-        # {config.exercise_name}
-
-        <!--- Insert exercise description -->
-
-        ## Task
-
-        <!--- Insert exercise task, simplify what needs to be done -->
-
-        ## Hints
-
-        <!--- Insert hints here -->
-        <!---
-            Use Github Markdown's collapsible content:
-            <details>
-            <summary>...</summary>
-            ...
-            </details>
-        -->
+        See https://git-mastery.github.io/lessons/{{LESSON_ID}}/exercise-{config.exercise_name}.html
         """
         readme_file.write(textwrap.dedent(readme).lstrip())
 
diff --git a/push_over/README.md b/push_over/README.md
@@ -1,9 +1 @@
-# push-over
-
-You have now started working on a remote repository with your friends 
-`push-over`. Start contributing to it!
-
-## Task
-
-Create a new commit on your local copy `push-this` and push the change to the 
-remote.
+See https://git-mastery.github.io/lessons/push/exercise-push-over.html
diff --git a/remote_branch_rename/README.md b/remote_branch_rename/README.md
@@ -1,12 +1 @@
-# remote-branch-rename
-
-## Task
-
-You have two branches: `try-quick-fix` and `improve-loadding` and you need to rename them.
-
-`try-quick-fix` is only available on your local machine, `improve-loadding` has already been pushed up to a remote repository, so you need a way around that!
-
-1. Rename the `try-quick-fix` branch to `fix-scrolling-bug`
-2. Rename the `improve-loadding` branch to `improve-loading`
-3. Ensure that the change is reflected on the remote repository as well
-
+See https://git-mastery.github.io/lessons/remoteBranchRename/exercise-remote-branch-rename.html
diff --git a/remote_control/README.md b/remote_control/README.md
@@ -1,11 +1 @@
-# remote-control
-
-You want to start a remote Git repository on Github.
-
-## Task
-
-Run `gitmastery verify` and follow the prompted name to create a new public 
-Github repository.
-
-Then, provide the URL into the prompt.
-
+See https://git-mastery.github.io/lessons/createRemoteRepo/exercise-remote-control.html
diff --git a/side_track/README.md b/side_track/README.md
diff --git a/stage_fright/README.md b/stage_fright/README.md
diff --git a/staging_intervention/README.md b/staging_intervention/README.md
diff --git a/under_control/README.md b/under_control/README.md
