git-ecosystem / git-ecosystem/git-credential-manager

Improve discoverability of time-saving config options

Open
#682 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help-wanted
Dominant language
C#
Stars
9.3k
Forks
2.9k
Avg merge
7d 1h
Merged PRs (30d)
14

Description

Config option credential.githubauthmodes can save the user time by remembering preferred authentication method, but this and similar config options are hard to discover without reading the docs.

A short message printed to terminal at the right moment could make relevant config options easier to discover, eg.

Select an authentication method for 'https://github.com/':
  1. Web browser (default)
  2. Device code
  3. Personal access token
option (enter for default): 1
info: always authenticate by web browser? git config --global credential.githubauthmodes browser
info: please complete authentication in your browser...

This would also help GUI users at the terminal, but not when git push is invoked via some other program without a terminal.

image

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.

Research direction

Start with docs/configuration.md and its credential.githubauthmodes section, then trace the terminal authentication-method selection described in the issue. Determine where a short, relevant configuration hint could be shown without affecting non-terminal callers. Done means the applicable options are discoverable at the right prompt and the message is absent when no terminal is available.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
authentication, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.