root
/
public
mirror of https://github.com/01-edu/public.git
8
9
Fork 0
Code Issues 2 Projects Releases Wiki Activity
Browse Source

docs(git) update readme and audit according to the review

pull/2516/head
miguel 2 months ago committed by MSilva95
parent
089ce817de
commit
a10884becc
2 changed files with 37 additions and 44 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 65
      subjects/git/README.md
  2. 16
      subjects/git/audit/README.md

65
subjects/git/README.md
unescape_control_characters View File

@ -21,7 +21,7 @@ Here is an example of a file that you can deliver to your auditor to help with t
```md ```md
#### Conflicts, merging and rebasing #### Conflicts, merging and rebasing
# Merge Main into Greeter Branch # Merge Main into Greet Branch
<Write the command here> <Write the command here>
@ -29,7 +29,7 @@ Here is an example of a file that you can deliver to your auditor to help with t
<Write the command here> <Write the command here>
# Merging Main into Greeter Branch (Conflict) # Merging Main into Greet Branch (Conflict)
<Write the command here> <Write the command here>
@ -41,11 +41,11 @@ Here is an example of a file that you can deliver to your auditor to help with t
<Write the command here> <Write the command here>
# Rebasing Greeter Branch # Rebasing Greet Branch
<Write the command here> <Write the command here>
# Merging Greeter into Main # Merging Greet into Main
<Write the command here> <Write the command here>
``` ```
@ -70,7 +70,7 @@ echo "Hello, World"
```sh ```sh
#!/bin/bash #!/bin/bash
echo "Hello, $1!" echo "Hello, $1"
``` ```
- Stage the changed file and commit the changes, the working tree should be clean. - Stage the changed file and commit the changes, the working tree should be clean.
@ -81,7 +81,7 @@ echo "Hello, $1!"
# Default is "World" # Default is "World"
name=${1:-"World"} name=${1:-"World"}
echo "Hello, $name!" echo "Hello, $name"
``` ```
- Make two separate commits: - Make two separate commits:
@ -128,7 +128,7 @@ echo "Hello, $name!"
# This is a bad comment. We want to revert it. # This is a bad comment. We want to revert it.
name=${1:-"World"} name=${1:-"World"}
echo "Hello, $name!" echo "Hello, $name"
``` ```
- **Staging and Cleaning**: - **Staging and Cleaning**:
@ -140,7 +140,7 @@ echo "Hello, $name!"
# This is an unwanted but staged comment # This is an unwanted but staged comment
name=${1:-"World"} name=${1:-"World"}
echo "Hello, $name!" echo "Hello, $name"
``` ```
- **Committing and Reverting**: - **Committing and Reverting**:
@ -152,7 +152,7 @@ echo "Hello, $name!"
# This is an unwanted but committed change # This is an unwanted but committed change
name=${1:-"World"} name=${1:-"World"}
echo "Hello, $name!" echo "Hello, $name"
``` ```
- **Tagging and Removing Commits**: - **Tagging and Removing Commits**:
@ -171,7 +171,7 @@ echo "Hello, $name!"
# Author: Jim Weirich # Author: Jim Weirich
name=${1:-"World"} name=${1:-"World"}
echo "Hello, $name!" echo "Hello, $name"
``` ```
- Oops the author email was forgotten, update the file to include the email without making a new commit, but include the change in the last commit. - Oops the author email was forgotten, update the file to include the email without making a new commit, but include the change in the last commit.
@ -180,16 +180,13 @@ echo "Hello, $name!"
- **Moving hello.sh**: - **Moving hello.sh**:
- Using Git commands, move the program `hello.sh` into a `lib/` directory, and then commit the move. - Using Git commands, move the program `hello.sh` into a `lib/` directory, and then commit the move.
- Create a `Rakefile` in the root directory of the repository with the provided content and commit it to the repository. - Create a `Makefile` in the root directory of the repository with the provided content and commit it to the repository.
```sh ```sh
#!/usr/bin/rake TARGET="lib/hello.sh"
task :default => :run run:
bash ${TARGET}
task :run do
sh './lib/hello.sh'
end
``` ```
#### blobs, trees and commits #### blobs, trees and commits
@ -218,7 +215,6 @@ Greeter() {
echo "Hello, $who" echo "Hello, $who"
} }
Greeter "$@"
``` ```
- Update the `lib/hello.sh` file by adding the content below, stage and commit the changes. - Update the `lib/hello.sh` file by adding the content below, stage and commit the changes.
@ -226,7 +222,7 @@ Greeter "$@"
```sh ```sh
#!/bin/bash #!/bin/bash
source greeter.sh source lib/greeter.sh
name="$1" name="$1"
if [ -z "$name" ]; then if [ -z "$name" ]; then
@ -236,20 +232,17 @@ fi
Greeter "$name" Greeter "$name"
``` ```
- Update the `lib/Rakefile` with the following content to ensure it runs the updated `lib/hello.sh` file. Commit these changes. - Update the `Makefile` with the following comment and commit the changes.
```sh ```sh
#!/bin/bash
# Ensure it runs the updated lib/hello.sh file # Ensure it runs the updated lib/hello.sh file
task :default => :run TARGET="lib/hello.sh"
task :run do run:
bash 'lib/hello.sh' bash ${TARGET}
end
``` ```
- Switch back to the `main` branch, compare and show the differences between the `main` and `greet` branches for `Rakefile`, `hello.sh`, and `greeter.sh` files. - Switch back to the `main` branch, compare and show the differences between the `main` and `greet` branches for `Makefile`, `hello.sh`, and `greeter.sh` files.
- Generate a `README.md` file for the project with the provided content. Commit this file. - Generate a `README.md` file for the project with the provided content. Commit this file.
```console ```console
@ -260,8 +253,8 @@ This is the Hello World example from the git project.
#### Conflicts, merging and rebasing #### Conflicts, merging and rebasing
- **Merge Main into Greeter Branch**: - **Merge Main into Greet Branch**:
- Start by merging the changes from the `main` branch into the `greeter` branch. - Start by merging the changes from the `main` branch into the `greet` branch.
- Switch to `main` branch and make the changes below to the `hello.sh` file, save and commit the changes. - Switch to `main` branch and make the changes below to the `hello.sh` file, save and commit the changes.
```sh ```sh
@ -273,14 +266,14 @@ read my_name
echo "Hello, $my_name!" echo "Hello, $my_name!"
``` ```
- **Merging Main into Greeter Branch (Conflict)**: - **Merging Main into Greet Branch (Conflict)**:
- Attempt to merge the `main` branch into `greeter`. Bingooo! There you have it, a `conflict`. - Attempt to merge the `main` branch into `greet`. Bingooo! There you have it, a `conflict`.
- Resolve the conflict (manually or using graphical merge tools), accept changes from `main` branch, then commit the conflict resolution. - Resolve the conflict (manually or using graphical merge tools), accept changes from `main` branch, then commit the conflict resolution.
- **Rebasing Greeter Branch**: - **Rebasing Greet Branch**:
- Go back to the point before the initial merge between `main` and `greeter`. - Go back to the point before the initial merge between `main` and `greet`.
- Rebase the `greeter` branch on top of the latest changes in the `main` branch. - Rebase the `greet` branch on top of the latest changes in the `main` branch.
- **Merging Greeter into Main**: - **Merging Greet into Main**:
- Merge the changes from the `greeter` branch into the `main` branch. - Merge the changes from the `greet` branch into the `main` branch.
- **Understanding Fast-Forwarding and Differences**: - **Understanding Fast-Forwarding and Differences**:
- Explain fast-forwarding and the difference between merging and rebasing. - Explain fast-forwarding and the difference between merging and rebasing.

16
subjects/git/audit/README.md
unescape_control_characters View File

@ -80,7 +80,7 @@
###### Did the student commit the move of `hello.sh`? ###### Did the student commit the move of `hello.sh`?
###### Did the student create and commit a `Rakefile` in the root directory of the repository with the provided content? ###### Did the student create and commit a `Makefile` in the root directory of the repository with the provided content?
#### blobs, trees and commits #### blobs, trees and commits
@ -104,9 +104,9 @@
###### Did the student update the `lib/hello.sh` file with the provided content, stage, and commit the changes? ###### Did the student update the `lib/hello.sh` file with the provided content, stage, and commit the changes?
###### Did the student update the `lib/Rakefile` with the provided content to ensure it runs the updated `lib/hello.sh` file, stage, and commit the changes? ###### Did the student update the `Makefile` with the comment, stage, and commit the changes?
###### Was the student able to compare and show the differences between the `main` and `greet` branches for the `Rakefile`, `hello.sh`, and `greeter.sh` files? ###### Was the student able to compare and show the differences between the `main` and `greet` branches for the `Makefile`, `hello.sh`, and `greeter.sh` files?
###### Did the student generate a `README.md` file with the provided content and commit it? ###### Did the student generate a `README.md` file with the provided content and commit it?
@ -114,21 +114,21 @@
#### Conflicts, merging and rebasing #### Conflicts, merging and rebasing
###### Did the student successfully merge the changes from the `main` branch into the `greeter` branch? ###### Did the student successfully merge the changes from the `main` branch into the `greet` branch?
###### Did the student make the specified changes to the `hello.sh` file in the `main` branch and commit them? ###### Did the student make the specified changes to the `hello.sh` file in the `main` branch and commit them?
###### Did the student attempt to merge the `main` branch into the `greeter` branch creating a conflict during the merge? ###### Did the student attempt to merge the `main` branch into the `greet` branch creating a conflict during the merge?
###### Did the student successfully resolve the conflict, accepting changes from the `main` branch? ###### Did the student successfully resolve the conflict, accepting changes from the `main` branch?
###### Did the student commit the conflict resolution changes? ###### Did the student commit the conflict resolution changes?
###### Did the student return to the point before the initial merge between `main` and `greeter`? ###### Did the student return to the point before the initial merge between `main` and `greet`?
###### Did the student rebase the `greeter` branch on top of the latest changes in the `main` branch? ###### Did the student rebase the `greet` branch on top of the latest changes in the `main` branch?
###### Did the student successfully merge the changes from the `greeter` branch into the `main` branch? ###### Did the student successfully merge the changes from the `greet` branch into the `main` branch?
##### Ask the student to explain the difference between merging and rebasing and if he understand Fast-Forwarding. ##### Ask the student to explain the difference between merging and rebasing and if he understand Fast-Forwarding.

Write Preview
Loading…
Cancel
Save