search

microsoft / vscode

Visual Studio Code
https://code.visualstudio.com
MIT License
163.41k stars 28.95k forks source link

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

Open sanfordstaab opened 10 months ago

sanfordstaab commented 10 months ago

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

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.
gjsjohnmurray commented 10 months ago

See https://github.com/microsoft/vscode/issues/168135#issuecomment-1340590009 for advice about how you can require use of the input box, which can handle multi - line messages.

That comment has a link to docs, though admittedly only in release notes.

gjsjohnmurray commented 10 months ago

Suggestion 2 at https://github.com/microsoft/vscode/issues/153680#issuecomment-1170016465 (adding an editor banner) might be worth pursuing.

FatimahAbdullah commented 6 months ago

Have been using VS Code for years and I agree that this feature has always been confusing.