magicmonty / magicmonty/bash-git-prompt

Document difference from git's git-prompt.sh

Open
#342 5 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
6.9k
Forks
983
Avg merge
13d 22h
Merged PRs (30d)
2

Description

It would be nice if the README explained how this differs from the git-prompt.sh script that's available in git's contrib directory, and who should use one vs. the other (depending on their needs / wants).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README and compare its documented prompt behavior with git's contrib/completion/git-prompt.sh. Document the practical differences and explain which script to choose for different needs; the README should make that choice clear to readers.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash, git
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.