Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gregorbiswanger/gitcommitwhisperer
Git Commit Whisperer generate Git commit messages in Visual Studio Code using OpenAI technology.
https://github.com/gregorbiswanger/gitcommitwhisperer
chatgpt extension generator git gitmessage openai visual-studio-code vscode vscode-extension
Last synced: 11 days ago
JSON representation
Git Commit Whisperer generate Git commit messages in Visual Studio Code using OpenAI technology.
- Host: GitHub
- URL: https://github.com/gregorbiswanger/gitcommitwhisperer
- Owner: GregorBiswanger
- License: mit
- Created: 2023-04-15T00:28:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-04-20T23:30:23.000Z (over 1 year ago)
- Last Synced: 2024-10-06T05:22:18.268Z (3 months ago)
- Topics: chatgpt, extension, generator, git, gitmessage, openai, visual-studio-code, vscode, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 108 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Commit Whisperer
**Git Commit Whisperer** is a Visual Studio Code extension that helps you generate git commit messages using OpenAI's GPT-3 (ChatGPT).
**WARNING** This extension transmits your git diff to OpenAI-API. Using this extension on confidential repositories is not advised, as it could potentially breach your NDA.
## Features
- Automatically generate git commit messages based on the diff of your changes
- Customize commit types using emojis
- Configure custom prompts for OpenAI's GPT-3
- Quick selection of commit types## Requirements
- An OpenAI API key is required to use this extension
## Installation
Install the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=GregorBiswanger.git-commit-whisperer).
## Usage
1. Make sure you have a valid OpenAI API key, which can be obtained [here](https://platform.openai.com/).
2. Configure the extension with your OpenAI API key:
- Either enter it directly in the settings (`generateCommitMessage.openaiApiKey`)
- Or, the extension will prompt you to enter your API key the first time you run the command
3. Execute the `Generate Commit Message` command from the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`).
4. If there are staged changes, select a commit type (or choose "Auto Detection") and let the extension generate a commit message for you.
5. The generated commit message will be placed in the Source Control input box.## Configuration
You can customize the behavior of the Git Commit Whisperer by modifying the following settings:
```json
{
"generateCommitMessage.openaiApiKey": "your-openai-api-key",
"generateCommitMessage.commitTypes": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"],
"generateCommitMessage.useEmojiForCommitType": false,
"generateCommitMessage.commitMessagePrompt": "your custom prompt"
}
```## Known Issues
- The extension might not work properly if the Git diff is very large or if there are too many changes.
- The commit message length might exceed the recommended 50 characters in some cases.## Contributing
If you have any suggestions or find any bugs, please open an issue on the [GitHub repository](https://github.com/GregorBiswanger/git-commit-whisperer).
## License
This extension is licensed under the [MIT License](https://github.com/GregorBiswanger/git-commit-whisperer/blob/main/LICENSE).