git_facade

Objectives

• Facade to reduce git command typing ceremony.

Syntax Definition

• Each function follows this notation: goaafl:
  • g := git. this does not change
  • o := git object
  • These are optional:
    • aa:= git action represented as two letters
    • fl:= flags
• Notation glossary:
  • g := git
  • o := git object
    • b := branch
    • r := repo
    • c := commit
    • s := stash
  • a := git action(s)
    • branch:
      • cl := clean
      • co := checkout
      • df := diff
      • dl := delete
      • ph := push
      • pp := pop
      • pl := pull
      • rb := rebase
      • rs := reset
      • st := status
    • commit:
      • am := amend
      • ph := push
    • repo:
      • cr := create
  • f := git flag(s)
    • a := all
    • c := continue
    • f := force
    • h := hard
    • n := new

Dependencies

• zsh

Setup Instructions

• Execute the script below.

  ./install.sh

• Reload open terminals and you are good to go.

Usage

• Example:

  # command:
  gbst
  
  # output:
  On branch main
  Your branch is up to date with 'origin/master'.
  
  Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
          modified:   README.md
  
  Un-tracked files:
  (use "git add <file>..." to include in what will be committed)
          _git_history_cleanup.sh
          _grlos.sh
  
  no changes added to commit (use "git add" and/or "git commit -a")

Git Conventions

• NB: The main is locked and all changes must come through a Pull Request.
• Commit Messages:
  • Provide concise commit messages that describe what you have done.

    # example:
    git commit -m "feat(core): algorithm" -m"implement my new shiny faster algorithm"

  • References:
    • https://www.conventionalcommits.org/en/v1.0.0/
    • https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/

Disclaimer: This is still work in progress.