Merge pull request #10 from AdyGCode/dev

Dev

Author: AdyGCode

.obsidian/workspace.json

@@ -4,11 +4,35 @@
     "type": "split",
     "children": [
       {
-        "id": "f854b54e1c2c8592",
+        "id": "8a32cc27797a4d1e",
         "type": "tabs",
         "children": [
           {
-            "id": "e74c320159094cdf",
+            "id": "20e1b75c65c12b41",
+            "type": "leaf",
+            "state": {
+              "type": "markdown",
+              "state": {
+                "file": "docs/15-diffs.md",
+                "mode": "source",
+                "source": false
+              }
+            }
+          },
+          {
+            "id": "411e3e90803f0f69",
+            "type": "leaf",
+            "state": {
+              "type": "markdown",
+              "state": {
+                "file": "docs/16-oopsy-undoing-changes.md",
+                "mode": "source",
+                "source": false
+              }
+            }
+          },
+          {
+            "id": "4ccbe8c51ef9a5f7",
             "type": "leaf",
             "state": {
               "type": "markdown",
@@ -19,7 +43,8 @@
               }
             }
           }
-        ]
+        ],
+        "currentTab": 2
       }
     ],
     "direction": "vertical"
@@ -129,7 +154,8 @@
               }
             }
           }
-        ]
+        ],
+        "currentTab": 1
       }
     ],
     "direction": "horizontal",
@@ -147,15 +173,19 @@
       "table-editor-obsidian:Advanced Tables Toolbar": false
     }
   },
-  "active": "e74c320159094cdf",
+  "active": "4ccbe8c51ef9a5f7",
   "lastOpenFiles": [
+    "docs/17-stashing.md",
+    "docs/18-workflows.md",
+    "docs/16-oopsy-undoing-changes.md",
+    "docs/15-diffs.md",
+    "16-.md",
+    "assets/pasted-image-20240315113136.png",
     "assets/Pasted image 20240314154647.png",
     "assets/Pasted image 20240314154551.png",
-    "docs/15-diffs.md",
     "assets/diff-difference.png",
     "assets/diff-hunk-headers.png",
     "assets/diff-header.png",
-    "docs/18-workflows.md",
     "docs/14-forking-over-code.md",
     "assets/Pull-Request-Practice.md",
     "assets/collaboration.png",
@@ -166,7 +196,6 @@
     "assets/pasted-image-20240314105028.png",
     "assets/pasted-image-20240314102512.png",
     "assets/front-cover.svg",
-    "assets/back-cover.svg",
     "assets/BLANK_README.md",
     "LICENSE.md",
     "CHANGELOG.md",
@@ -185,8 +214,6 @@
     "docs/09-git-history.md",
     "docs/07-ignore-me.md",
     "docs/05-global-settings.md",
-    "docs/04-git-started.md",
-    "docs/02-getting-ready.md",
     "docs",
     "assets/brave_dWSQwZYc3F.mp4",
     "themes",

assets/pasted-image-20240315113136.png

@@ -12,28 +12,31 @@ When you run a merge – it is asking the same question.
 
 Pull or push – yep, you guessed it...
 
+### Git Merge explained using Soldiers
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/4zw7dO46XSQ?si=0ssNcD8S-ukHV3R4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+
 ## What is the difference?
 
 We will want to know there is a difference, but this is often not enough.
 
 When we know there is a difference, we then want to know what the difference is.
 
+You saw an example of differences when you ran a pull request.
 
-•You saw an example of differences when you ran a pull request
-
-•Discuss on what levels were differences highlighted (folder/file/line/word/character)?
-
+![Inside the Pull Request Files Changed - post merge](../assets/pasted-image-20240315113136.png)
 
 ## When can diffs be seen?
 
-•Between files
-
-•Between commits
+You are able to view diffs between a number of 'objects' that make up the Git version control 'history'.
 
-•Between staging (index) and the object database (repo)
-
-•Between the working copy and any of the above
+You may look at diffs between:
 
+- Files
+- Commits
+- Staging (index) and the object database (repo)
+- The working copy and any of the above
 
 # Diff Interpretation
 
@@ -83,10 +86,19 @@ For example:
 
 What line numbers in each file do these changes relate to?
 
+## Git Diff Explained
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/vXN50AmJjgY?si=-hRWjzRZfKLPoOtt" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
 
 
 # References
 
 Content based on the following:
 
-www.oreilly.com. (n.d.). _3. Looking Around: Investigating Your Git Repository - Head First Git [Book]_. [online] Available at: https://learning.oreilly.com/library/view/head-first-git/9781492092506/ch03.html [Accessed 14 Mar. 2024].
+www.oreilly.com. (n.d.). _3. Looking Around: Investigating Your Git Repository - Head First Git [Book]_. [online] Available at: https://learning.oreilly.com/library/view/head-first-git/9781492092506/ch03.html [Accessed 14 Mar. 2024].
+
+www.youtube.com. (n.d.). _Git Diff - Explained_. [online] Available at: https://www.youtube.com/watch?v=vXN50AmJjgY [Accessed 15 Mar. 2024].
+
+
+
+[Forking](14-forking-over-code/md) | [Undoing changes](16-oopsy-undoing-changes.md)

docs/15-diffs.md

@@ -0,0 +1,61 @@
+# Undoing Changes
+
+You've made an error in your commits, merges or such ... do not worry, it happens to the best of us.
+
+Remember that Git stores EVERYTHING.
+
+The problem is that this isn't always the best thing.
+
+We will make errors such as:
+- Accidently add a file you did not want to add.
+- Make a commit you didn’t intend to commit (too soon, wrong branch, etc).
+- Make a commit and decide you want to change it or its commit message.
+- Push a change you didn’t mean to push.
+- Make updates to your working copy you want to remove!
+
+Making these errors will happen at some point.
+
+## We will mend it, we will fix it...
+
+Anything can be fixed but the difficulty level does rise pretty quickly. Some may say exponentially.
+
+In general, there are two strategies:
+- Revert changes by creating a new commit
+- Reset changes by removing them from history
+
+Each has their respective advantages.
+
+|                         | Git Revert                                                   | Git Reset                                                                        |
+| ----------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------- |
+| **Operation**           | Creates a new commit that undoes changes                     | Moves the branch pointer to a previous commit                                    |
+| **Commit History**      | Preserves the original commit history                        | Modifies the commit history                                                      |
+| **Branch State**        | Updates the branch with a new commit                         | Moves the branch pointer to a different commit                                   |
+| **Working Directory**   | Does not modify the working directory                        | Can optionally modify the working directory                                      |
+| **Collaboration**       | Safe for shared repositories, as it creates a new commit     | Potentially dangerous for shared repositories, as it rewrites the commit history |
+| **Use Cases**           | Undoing commits, fixing mistakes, reverting changes          | Discarding local commits, cleaning up history, resetting to a previous state     |
+| **Remote Repositories** | Suitable for reverting changes pushed to remote repositories | Not suitable for resetting changes pushed to remote repositories                 |
+
+## Warning: Reset Danger
+
+WARNING: resets are hazardous!
+
+You run the risk of:
+- Losing work.
+- Misaligning the commit history (after push).
+
+## Git Reset
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/iEgCj-d-G5U?si=oHntqxD_L65V_k-E" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+## Git Revert
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/XJqQPNudPSY?si=RapMB35X1eefT6N4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+# References
+
+A Shot of Code (2023). _Git Reset Visualized_. [online] www.youtube.com. Available at: https://www.youtube.com/watch?v=iEgCj-d-G5U&list=PLvVKmViR0Z7aKwZjgICrjp0wUYMF_IpGX&index=14 [Accessed 15 Mar. 2024].
+
+A shot of code (2023). _Git Revert - Visualised_. [online] www.youtube.com. Available at: https://www.youtube.com/watch?v=XJqQPNudPSY&list=PLvVKmViR0Z7aKwZjgICrjp0wUYMF_IpGX&index=15 [Accessed 15 Mar. 2024].
+
+
+[Diffs](14-diffs.md) | [Stashing](17-stashing.md)

docs/16-oopsy-undoing-changes.md

@@ -0,0 +1,65 @@
+# Stashing Changes
+
+We all know what squirrels and other animals do, the put away food for harsh times. They create a secret stash.
+
+Mush like this, Git also has the ability to stash.
+
+Stashing is simply putting work aside whilst you do something else.
+
+## Stashing
+
+A common situation for the use of stashing is when uncommitted changes get in the way of branching.
+
+This often occurs when one branch is ahead of your working copy. The act of switching to the other branch would then lead to git clobbering your changes.
+
+Thankfully, Git will not let that happen.
+
+So what do you do? Have a think how you could resolve the problem.
+
+### This is one possible solution
+
+So when the above scenario occurs you would have to:
+
+- Copy the changes – you are not sure what files changed, so you probably grab everything (yuck!)
+- Copy to another folder (yuck yuck)
+- Use git reset --hard to DESTROY the working copy changes (yuck yuck yuck)
+- Switch to the branch
+- Do work
+- Switch back, copy all the files back and really really hope you didn’t stuff everything up
+
+### Or... Making Life Easier
+
+That is both nasty and long winded... so we can make it easier by using a stash of changes:
+
+- git stash
+- switch
+- switch back
+- git stash pop
+
+And there you have it... we are done!
+
+## This is a Public Service Announcement
+
+Git stash is sometimes not taught in an introduction to Git.
+
+The problem with this it that it is just about the most useful command you can find to make working with Git seamless.
+
+This is particularly true if you are branch/working with a remote, that is, using git as intended!
+
+# Time for your Supplements
+
+This video is on Git Stash... The audio at the start may be a little off centre.
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/adzewZEj2Pg?si=KJKuu2p7pTi3soDL" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
+# References
+
+Adhikary, T. (2023). _10 Git stash commands every developer should know_. [online] GreenRoots Blog - Tapas Adhikary. Available at: https://blog.greenroots.info/10-git-stash-commands-every-developer-should-know [Accessed 15 Mar. 2024].
+
+Programming Peanut (n.d.). _[Git] What is Git Stash and how to use it_. [online] www.youtube.com. Available at: https://www.youtube.com/watch?app=desktop&v=adzewZEj2Pg [Accessed 15 Mar. 2024].
+
+
+
+---
+
+[Undoing Changes](docs/16-oopsy-undoing-changes.md) | [Workflows](18-workflows.md)

docs/17-stashing.md

@@ -2,7 +2,7 @@
 
 The video by Nick Chapsas "Getting started with branching workflows, Git Flow and GitHub Flow" provides a summary of these two workflows.
 
-[Getting started with branching workflows, Git Flow and GitHub Flow (youtube.com)](https://www.youtube.com/watch?v=gW6dFpTMk8s)
+<iframe width="560" height="315" src="https://www.youtube.com/embed/gW6dFpTMk8s?si=H6Hhn5CDRE5BLNSD" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
 
 ## Git Flow Workflow
 
@@ -14,14 +14,18 @@ Here's how it works:
 
 1. **Main Branches**: There are two main branches:
     - `main`(or `master`): This is the branch that contains the production-ready code.
+      
     - `develop`: This is the branch where all the new features and bug fixes are integrated before being merged into
       the`main`branch.
+      
 2. **Supporting Branches**: There are also supporting branches for specific tasks:
     - `feature`branches: These branches are used to develop new features. When a feature is complete, it is merged back
       into the`develop`branch.
+      
     - `release`branches: When the`develop`branch is stable and ready for a release, a`release`branch is created from it.
       This is where any last-minute bug fixes or documentation updates are made before the release is merged into
       the`main`branch and tagged with a version number.
+      
     - `hotfix`branches: These branches are used to quickly fix critical issues in the production code (`master`branch).
       When the fix is complete, it is merged back into both the`main`and`develop`branches.
 
@@ -36,24 +40,33 @@ It's designed to work well with GitHub's features and allows for more frequent d
 Here's how it works:
 
 1. **Main Branch**: There is only one main branch, typically called`main`or `master`.
+   
 2. **Feature Branches**: Whenever you want to work on a new feature or bug fix, you create a new branch from the `main`
    branch.
+   
 3. **Pull Requests**: When you're ready to merge your changes back into the `main` branch, you create a Pull Request. This
    allows others to review your code and provide feedback before merging.
+   
 4. **Code Reviews**: The Pull Request triggers a code review process, where team members can discuss the changes,
    suggest improvements, or request additional changes.
+   
 5. **Merge and Deploy**: Once the code has been reviewed and approved, the feature branch is merged into the `main`
    branch. This merged code can then be deployed to production.
 
 GitHub Flow encourages frequent, small updates to the codebase, making it easier to manage and integrate changes.
 
-## Further Reading and Tutorials
 
-Select one or two to review and make notes about.
+# References
 
-Feel free to feedback as to what you think about the selected items.
+The references show details of any articles, videos and other items that were used in this chapter, plus other, possibly useful items.
+
+Chapsas, N. (2021). _Getting started with branching workflows, Git Flow and GitHub Flow_. [online] www.youtube.com. Available at: https://www.youtube.com/watch?v=gW6dFpTMk8s [Accessed 15 Mar. 2024].
+
+Git Dailies (n.d.). _Guide to Git Flow_. [online] GitDailies: Software Engineering Metrics Made Easy. Available at: https://gitdailies.com/articles/git-flow-guide/ [Accessed 15 Mar. 2024].
+
+
+Other links
 
-- [Guide to Git Flow (gitdailies.com)](https://gitdailies.com/articles/git-flow-guide/)
 - [Git Workflow | Atlassian Git Tutorial](https://www.atlassian.com/git/tutorials/comparing-workflows)
 - [How To Use Git Flow Effectively (marketsplash.com)](https://marketsplash.com/tutorials/git/git-flow/)
 - [Git Flow | Developer Experience Knowledge Base](https://developerexperience.io/articles/git-flow)
@@ -68,5 +81,9 @@ Feel free to feedback as to what you think about the selected items.
 - [Understanding the GitHub Flow | GitHub Guides (gitbooks.io)](https://roachhd.gitbooks.io/github-guides/content/flow/flow.html)
 - [Git Flow vs GitHub Flow | Alex Hyett](https://www.alexhyett.com/git-flow-github-flow/)
 - [Git Flow vs GitHub Flow: What You Need to Know (youtube.com)](https://www.youtube.com/watch?v=hG_P6IRAjNQ&feature=youtu.be)
--
-- 
+- ...
+
+
+
+
+[Stashing](17-stashing.md) | [...](.)