magicmonty / magicmonty/bash-git-prompt
Feature: add a new `git_prompt_explain` command to describe the current prompt to new-comers
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 6.9k
- Forks
- 983
- Avg merge
- 13d 22h
- Merged PRs (30d)
- 2
Description
Hello,
i just set up this in my bash terminal and it looks very nice! I'm sure at some point i'm going to remember all the symbols and stuff, but for now some of them are still a bit unclear what they are.
so it would be extremely helpful to have a new command, git_prompt_explain that provides a textual description of the terminal.
for example:
(extra info) [master ↑·7|✔]>
> git_prompt_explain
current branch: master
the branch is 7 commits ahead
the branch is clean
or
(extra info) [morph L|✚ 1 …2]>
current branch: morph
this is a local-only branch
1 file has been changed but not staged
there are 2 untracked objects in the repository
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing prompt output and the symbols shown in the examples to map what the new command should explain. Define coverage for branch state, commit divergence, cleanliness, staged and unstaged files, and untracked objects; done means git_prompt_explain produces accurate text for those states.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100