Commit GPT - Visual Studio Code Extension

Commit GPT is a Visual Studio Code extension that generates commit messages using your GitHub Copilot chat model access, via VS Code's Language Model API. It helps developers create descriptive and meaningful commit messages based on the staged changes in their Git repository.

Features

• Commit Message Generation: Automatically generates commit messages based on the staged changes in your Git repository.
• Copilot Integration: Uses VS Code's Language Model API to generate human-like and context-aware commit messages via your GitHub Copilot access — no separate API key needed.
• Customizable: Lets you choose which Copilot chat model family to use for generation.
• Easy to Use: Simple commands to generate commit messages and select a chat model directly within VS Code.

Requirements

• Visual Studio Code (version 1.91.0 or higher)
• GitHub Copilot (installed and signed in) — Commit GPT generates messages via VS Code's Language Model API, using whichever Copilot chat model you have access to. No separate API key needed.

Installation

1. Install Visual Studio Code on your system if you haven't already: Download VS Code.
2. Launch VS Code.
3. Go to Extensions (or press Ctrl+Shift+X).
4. Search for "Commit GPT".
5. Click Install to install the extension.

Usage

1. (Optional) Choose a chat model:

   • Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on Mac).
   • Type Commit GPT: Select Chat Model and press Enter.
   • Pick which Copilot chat model family to use from the list. If you skip this step, Commit GPT uses whichever Copilot model is available.

2. Generate Commit Message:

   • Stage your changes in Git.
   • Open the Command Palette.
   • Type Commit GPT: Generate Commit Message and press Enter.
   • Or click the Commit GPT button (a grey commit node with a blue spark) in the Source Control title bar. The message streams into the commit box as it is written.
   • Nothing staged? Commit GPT offers to stage everything and generate in one click.

3. Not quite right? Run Commit GPT: Regenerate Commit Message with Hint… (also in the Source Control … menu) and say what to change, e.g. "make it shorter" or "mention ABC-123".

Configuration

• commit-gpt.style: conventional (default), gitmoji, or plain.
• commit-gpt.model: The Copilot chat model family used to generate commit messages. Set this using the Commit GPT: Select Chat Model… command or directly in your VS Code settings. Empty means the first available model.
• commit-gpt.customPrompt: Your own prompt template. Use {{diff}} where the staged diff should go. Overrides style.

Known Issues

• No known issues.

Release Notes

Version 1.0.0

• Initial release of Commit GPT extension.

Feedback and Contributing

• If you find any issues or have suggestions for improvement, please report them.
• Contributions are always welcome! Fork the repository and submit a pull request.

License

This extension is licensed under the MIT License.

---

Feel free to replace placeholders such as your-repo-url with the appropriate links to your GitHub repository or issue tracker. Additionally, you can add more sections, such as "Acknowledgments," "Support," or "Author," to provide further information about your extension.