Link to git-prompt.sh in "A1.6 Git in Bash"

Open Beginner friendly
#2,062 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start at the “A1.6 Git in Bash” chapter and locate the paragraph mentioning contrib/completion/git-prompt.sh. Add links to the file and Git source repository as proposed, then decide whether the optional curl snippet belongs there; the rendered chapter should make the file easy to find and preserve the existing setup guidance.

Written by the indexing model from the issue text.

Description

enhancement
General overview of your idea.

In the "A1.6 Git in Bash· chapter, it points you to a git-prompt.sh file in the git repository, but it doesn't provide any links. I had to go thru a bit of googling to find the file in question.

I think it would be useful to provide at the very least a link to the repository, or even directly to the file, or both. Tu turn this paragraph:

To add these to your prompt, just copy the contrib/completion/git-prompt.sh file from Git’s source repository to your home directory, add something like this to your .bashrc:

Into this:

To add these to your prompt, just copy the contrib/completion/git-prompt.sh file from Git’s source repository to your home directory, add something like this to your .bashrc:

Could even add a code snippet right after to curl the file into the right location:

curl -o ~/git-prompt.sh https://raw.githubusercontent.com/git/git/master/contrib/completion/git-prompt.sh

If you think it's a good idea I can create a pull request implementing the change.

What problem will this solve?

Making the experience of setting up a bash git prompt more straightforward

Have you thought about other solutions?

No response

Do you want to help with this enhancement idea?

Yes

Dominant language
CSS
Stars
6.6k
Forks
2.1k
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

More from progit/progit2

All issues in progit/progit2

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.