Quickstart

December 28, 2022 ยท View on GitHub

How to install and run the extension in VS Code.

Install

Go to the Marketplace link below, then click the Install button.

VS Code Marketplace - Auto Commit Message

Run

Use the extension like this:

  1. Open VS Code.
  2. Open a project which is a Git repo.
  3. Edit one or more files and save them.
  4. Optionally stage one of the files.
    • This is useful if want smaller changes in your commit and your commit message.
    • Staging is necessary if you do a move or rename action, so that Git sees the old and new path as the same file. But otherwise, you don't have to stage.
  5. In VS Code's built-in Git pane, click the Auto Commit Message icon.
  6. The extension will create a descriptive commit message for you in the commit message box.
  7. Optionally edit your message.
  8. Commit - click the tick symbol button. Or Control+Enter or CMD+Enter.