ChatGPT Commit Message Summarizer

Welcome to ChatGPT Commit Message Summarizer, a VSCode extension that generates commit messages from Git diffs using OpenAI's GPT-3.5 language model.

Features

This extension provides a command to generate a Git commit message that summarizes changes to the currently opened file. The generated commit message is based on the Git diff of the file, and the length of the diff used can be set in the settings to prevent excessive usage of the GPT-3.5 API, which can result in high costs.

Requirements

To use this extension, you must have Git installed on your system and available on the command line. Additionally, you will need to obtain an OpenAI API token to use the GPT-3.5 language model. Extension Settings

This extension contributes the following settings:

• chatgpt-commit-message-summarizer.diffWordLimit: Limit the number of words in the Git diff that the extension will use to generate the commit message. The default limit is 50.
• chatgpt-commit-message-summarizer.chatGptApiToken: Your OpenAI API token to use the GPT-3.5 language model. This token must be provided for the extension to work.

Usage

1. Enter your API key in the settings using Ctrl + ,. Search for chatgpt-commit-message-summarizer.chatGptApiToken to find the necessary setting.
2. Open the file for which you want to summarize changes.
3. Press Ctrl + Shift + P to open the command palette.
4. Type "Summarize Git Diff" and select the corresponding command.
5. The extension will generate a commit message based on the Git diff of the file using OpenAI's GPT-3.5 language model.
6. Review the generated commit message in the input box.
7. Press Enter to commit the changes or Esc to cancel the commit.

Known Issues

There are currently no known issues with this extension.

Release Notes

1.0.0

• Initial release of ChatGPT Commit Message Summarizer.

For Developers

If you want to modify the extension, the source code is available at Ishidres/vscode-chatgpt-git-commit-message-summarizer on GitHub. Feel free to improve this extension using pull requests!

Developing

To get started, you will need to install the necessary dependencies by running the following command in your terminal:

npm install

Then, you can open the project in VSCode by running:

code .

Finally, you can run the extension by pressing F5 or by using the "Run Extension" command in the VSCode Debug sidebar.

Please note that you will need to set your OpenAI API token in the extension's settings to use the GPT-3.5 language model. The token can be obtained from the OpenAI website.

License

By using this project or installing this extension, you agree to be bound by the terms and conditions of the license located at the LICENSE file in this repository. If you do not agree to the terms of the license, do not use this project or install this extension.