File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -20,7 +20,12 @@ This extension is not available in the extensions library. You can build and ins
2020
2121[ Docs website] ( https://michaelcurrin.github.io/llm-commit-msg-vs-code/ )
2222
23- ## Sample
23+ ## Quickstart
24+
25+ 1 . Ensure Ollama in installed.
26+ 1 . In VS Code, open a Git repository and stage your changes.
27+ 1 . Click ` Generate Commit Message (LLM) ` in the Source Control title bar (or run the command via the Command Palette).
28+ 1 . Edit if needed, then commit.
2429
2530<div align =" center " >
2631 <img src="https://raw.githubusercontent.com/MichaelCurrin/llm-commit-msg-vs-code/main/sample.png"
Original file line number Diff line number Diff line change 55
66This VS Code extension generates high‑quality Git commit messages using a local LLM exposed via an OpenAI‑compatible API (e.g. Ollama).
77
8- - [ Installation] ( installation.md )
8+ - [ Installation] ( installation.md ) - setup and run for extension users
99- [ Usage] ( usage.md )
1010- [ Development] ( development/ )
1111
12- ## Quickstart
13-
14- 1 . Ensure Ollama.
15- 1 . In VS Code, open a Git repository and stage your changes.
16- 1 . Click ` Generate Commit Message (LLM) ` in the Source Control title bar (or run the command via the Command Palette).
17- 1 . Edit if needed, then commit.
18-
19-
2012## Notes
2113
2214- Requires the VS Code Git extension and an active Git repository.
Original file line number Diff line number Diff line change @@ -4,10 +4,10 @@ Generate a commit message from your staged changes.
44
55## Steps
66
7- - Stage the changes you want included in the message.
8- - Open the Source Control view in VS Code.
9- - Click the ` Generate Commit Message (LLM) ` action in the SCM title bar, or run the command from the Command Palette.
10- - The extension fills the commit message input. If it cannot, it copies the message to the clipboard and shows a notification.
7+ 1 . Stage the changes you want included in the message.
8+ 1 . Open the Source Control view in VS Code.
9+ 1 . Click the ` Generate Commit Message (LLM) ` action in the SCM title bar, or run the command from the Command Palette.
10+ 1 . The extension fills the commit message input. If it cannot, it copies the message to the clipboard and shows a notification.
1111
1212## Tips
1313
You can’t perform that action at this time.
0 commit comments