feat(git): show notification hint when commit message editor opens#307640
Open
yogeshwaran-c wants to merge 1 commit intomicrosoft:mainfrom
Open
feat(git): show notification hint when commit message editor opens#307640yogeshwaran-c wants to merge 1 commit intomicrosoft:mainfrom
yogeshwaran-c wants to merge 1 commit intomicrosoft:mainfrom
Conversation
When the commit message editor opens, an information notification now appears telling the user they can close the tab or use the toolbar Commit button to finish their commit. This addresses the common confusion where users don't realize they need to close the editor to proceed with the commit. The notification also includes a "Commit" action button for quick access. Closes microsoft#199097 Closes microsoft#153509
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Feature - UX improvement for the git commit message editor workflow.
What is the current behavior?
When the commit message editor opens (via
git.useEditorAsCommitInputorgit commitfrom terminal), users are given no guidance on how to proceed. The only way to finish the commit is to close the editor tab, but this is not obvious -- especially for new users. The "Commit" and "Cancel" buttons exist in the editor toolbar, but users often miss them.Closes #199097
Closes #153509
What is the new behavior?
When the commit message editor opens, an information notification appears with:
git.commitMessageAcceptcommandThis makes the workflow discoverable for all users without requiring them to find documentation or toolbar buttons.
Additional context
This is the simplest possible solution to a long-standing usability issue (open since 2022). The maintainer @lszomoru suggested using a banner to provide guidance, and this notification serves that purpose.
Files changed:
extensions/git/src/gitEditor.ts(1 file, +11/-1 lines)Testing:
git.useEditorAsCommitInput(default)