Simon Parker
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights New
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    # Opinionated Git ## The Happy Path --- ## 🎯 Goals - ✍️ Establish guiding principles for Git usage - 🛠 Introduce tools aligned with these principles - 🤔 Have fun solving puzzles! --- ## 🙀 Anti-goals - A complete overview of the Git API or internals - An explanation of more complex branching models, such as [git flow](https://nvie.com/posts/a-successful-git-branching-model/) - "Advanced" git-fu and how to get out of common git conundrums (planning a separate workshop for this) --- ## ✍️ Guiding Principles - **`master` is the source of truth** and should be production-ready at all times - **`feature` branches track work in progress** and should be short-lived - **`git log` tells the story of our product** and should be linear --- ## 🏁 Let's get started! 1. Make sure `git` is [installed on your machine](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) 1. Install [pivotal workstation setup](https://github.com/pivotal/workstation-setup) 1. Clone the workshop repository ```bash git clone https://github.com/simon-parker/git-workshop cd git-workshop ``` --- ## 🛠 Reading `git log` output ```bash git log --oneline --decorate --all --graph # aka `git lola` ``` - `HEAD` is your current location in the repository - `(master, branch)` show your **local** branches/tags. - `(origin/master, origin/branch)` show your **remote tracking** branches/tags. --- ## 🛠 Moving about ```bash git checkout <commitish> ``` `<commitish>` can be a number of things, including: - `git checkout <commit-hash>` - `git checkout <branch-or-tag-name>` - `git checkout <commitish>~1` - `git checkout <commitish>~` --- ## 🤔 Puzzle Time! (5 minutes) Try to solve the puzzle as efficiently as you can! ```bash cd puzzles/checkout-them-all source init ``` --- ## 🛠 Creating commits ```bash git add . git add "src" git add "*.sh" git add "*/test/*" git commit -m "commit message" git commit --amend -m "amended commit" ``` --- ## 🛠 Creating new branches ```bash git checkout -b new-branch ``` The new branch will appear at `HEAD` --- ## 🤔 Puzzle Time! (5 minutes) ```bash cd puzzles/branch-gardening source init ``` --- ## 🛠 Rebasing: a fork in the road What situation led to this branching? ```graphviz digraph hierarchy { nodesep=0.5 // increases the separation between nodes node [shape=box, style=rounded] //rankdir=LR; master, feature [style="square", color="red"] feature -> "feature commit" -> "shared commit" master -> "master commit" -> "shared commit" } ``` --- ## 🛠 Rebasing: linear history ```bash git checkout feature-branch git rebase master ``` ```graphviz digraph hierarchy { nodesep=0.5 // increases the separation between nodes node [shape=box, style=rounded] //rankdir=LR; master, feature [style="square", color="red"] feature -> "feature commit" -> "master commit" -> "shared commit" master -> "master commit" } ``` ✍️ Rebasing makes our history easy to understand by making it **linear**! --- ## 🛠 Merging ✍️ We are not done until our changes are on `master`, the **source of truth**! ```bash git checkout master git merge feature ``` ```graphviz digraph hierarchy { nodesep=0.5 // increases the separation between nodes node [shape=box, style=rounded] //rankdir=LR; master, feature [style="square", color="red"] feature, master -> "feature commit" -> "master commit" -> "shared commit" } ``` --- ## 🛠 Merging: cleaning up ✍️ Once our changes are on our **source of truth**, we should delete our **short-lived feature branch**. ```bash git checkout master git merge feature git push master git branch -D feature # delete local branch git push --delete feature # delete remote branch # delete any remote tracking branches # others have deleted with git push --delete git fetch -p ``` --- ## 🤔 Puzzle Time! (10 minutes) ```bash cd puzzles/rebase-madness source init ``` --- ## 🎁 Bonus: The `-` shortcut Like `bash`, Git will treat a `-` as an alias for your previous location in the tree It works with `git checkout`, `git rebase` and `git merge`! --- ## 🤔 What does this do? ```bash git checkout feature-branch # ... do some work git checkout master git pull -r git checkout - git rebase - git checkout - git merge - git push ``` --- ## 🤔 Puzzle Time! (10 minutes) It's time to bring together everything we learned and go through a full day in the life of a pair! ```bash cd puzzles/day-in-the-life source init ``` --- ## 🎉 Thank you! 🙏 In the spirit of continuous improvement, <a href="mailto:simon@parker.run?subject=Git (Happy Path) Feedback&body=One thing I learned was: %0A%0AOne way the workshop can be improved in the future: ">please send me an e-mail</a> with the following feedback: - One thing you learned during this workshop - One way it can be improved in the future 😎 **That's all, folks!** 😎 --- ## 📝 References - [Trunk-Based Development](https://trunkbaseddevelopment.com/) - [Git Documentation](https://git-scm.com/) - [Pivotal Workstation Setup](https://github.com/pivotal/workstation-setup) - [Explain Shell](https://explainshell.com/explain?cmd=git+log+--oneline+--graph+--decorate+--all)

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully