https://github.com/praisetompane/git_facade
Facade to reduce git command typing ceremony.
https://github.com/praisetompane/git_facade
git shell zsh
Last synced: about 1 year ago
JSON representation
Facade to reduce git command typing ceremony.
- Host: GitHub
- URL: https://github.com/praisetompane/git_facade
- Owner: praisetompane
- License: mit
- Created: 2024-12-03T13:02:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-12T16:49:40.000Z (about 1 year ago)
- Last Synced: 2025-04-12T17:41:47.798Z (about 1 year ago)
- Topics: git, shell, zsh
- Language: Shell
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
- co := checkout
- cl := clean
- df := diff
- dl := delete
- ph := push
- pl := pull
- rb := rebase
- rs := reset
- st := status
- commit:
- am := amend
- ph := push
- repo:
- i := initialize
- f := git flag(s)
- a := all
- c := continue
- f := force
- h := hard
- n := new
## Dependencies
- zsh
## Setup Instructions
- Execute the script below.
```shell
./install.sh
```
- Reload open terminals and you are good to go.
## Usage
- Example:
```shell
# command:
gbst
# output:
On branch main
Your branch is up to date with 'origin/master'.
Changes not staged for commit:
(use "git add ..." to update what will be committed)
(use "git restore ..." to discard changes in working directory)
modified: README.md
Un-tracked files:
(use "git add ..." 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.
```shell
# 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.