Microsoft/vscode

Git - Docs for commiting via multi-line git are unclear on how to finish the commit

Open

#199,097 opened on Nov 25, 2023

View on GitHub
 (3 comments) (0 reactions) (1 assignee)TypeScript (10,221 forks)batch import
feature-requestgithelp wantedux

Repository metrics

Stars
 (74,848 stars)
PR merge metrics
 (Avg merge 11h 43m) (1,000 merged PRs in 30d)

Description

Does this issue occur when all extensions are disabled?: Yes/No

  • VS Code Version:
  • OS Version:

Steps to Reproduce:

  1. Open the git view in vscode (ctrl-shift-G) (assuming you are working within a Git repo)
  2. Click on the commit button to reveal the multiline commit message editor.
  3. Fill in your multi-line message for the commit.
  4. Save the editor (nothing seems to happen except the usual save action)
  5. There is no UI clue that tells you that you can/must close the editor to submit the commit message to finish the commit. The docs don't seem to call this out either. Took me a long time before I realized I could finish the commit this way.

Contributor guide

Research direction
Improve the documentation for multi line commits in VS Code's Git view to explicitly state that closing the editor submits the commit.
Tech stack
typescript
Domain
developer experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85