Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sitoi/ai-commit

Use Azure/OpenAI API to review Git changes, generate conventional commit messages that meet the conventions, simplify the commit process, and keep the commit conventions consistent.
https://github.com/sitoi/ai-commit

azure chatgpt commit commit-conventions commit-message gpt gpt-4 vscode vscode-extension

Last synced: 2 months ago
JSON representation

Use Azure/OpenAI API to review Git changes, generate conventional commit messages that meet the conventions, simplify the commit process, and keep the commit conventions consistent.

Host: GitHub
URL: https://github.com/sitoi/ai-commit
Owner: Sitoi
License: mit
Created: 2023-10-31T06:32:18.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2023-12-28T04:25:02.000Z (about 1 year ago)
Last Synced: 2024-10-11T09:45:20.496Z (3 months ago)
Topics: azure, chatgpt, commit, commit-conventions, commit-message, gpt, gpt-4, vscode, vscode-extension
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=Sitoi.ai-commit
Size: 2.14 MB
Stars: 21
Watchers: 2
Forks: 6
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: license

Awesome Lists containing this project

README

        





AI Commit


Use Azure/OpenAI API to review Git changes, generate conventional commit messages that meet the conventions, simplify the commit process, and keep the commit conventions consistent.

**English** · [简体中文](./README.zh_CN.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]

[![][github-contributors-shield]][github-contributors-link]

[![][github-forks-shield]][github-forks-link]

[![][github-stars-shield]][github-stars-link]

[![][github-issues-shield]][github-issues-link]

[![][vscode-marketplace-shield]][vscode-marketplace-link]

[![][total-installs-shield]][total-installs-link]

[![][avarage-rating-shield]][avarage-rating-link]

[![][github-license-shield]][github-license-link]

![](https://github.com/sitoi/ai-commit/blob/main/aicommit.gif?raw=true)



## ✨ Features

- 🤯 Support generating commit messages based on git diffs using ChatGPT / Azure API.

- 🗺️ Support multi-language commit messages.

- 😜 Support adding Gitmoji.

- 📝 Support Conventional Commits specification.

## 📦 Installation

1. Search for "AI Commit" in VSCode and click the "Install" button.

2. Install it directly from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Sitoi.ai-commit).

> **Note**\

> Make sure your node version >= 16

## 🤯 Usage

1. Ensure that you have installed and enabled the "AI Commit" extension.

2. In VSCode settings, locate the "ai-commit" configuration options and configure them as needed.

3. Make changes in your project and add the changes to the staging area (git add).

4. Next to the commit message input box in the "Source Control" panel, click the "AI Commit" icon button. After clicking, the extension will generate a commit message and populate it in the input box.

5. Review the generated commit message, and if you are satisfied, proceed to commit your changes.

> **Note**\

> If the code exceeds the maximum token length, consider adding it to the staging area in batches.

### ⚙️ Configuration

In the VSCode settings, locate the "ai-commit" configuration options and configure them as needed:

| Configuration      |  Type   |    Default    | Required |                                            Notes                                             |

| :----------------- | :-----: | :-----------: | :------: | :------------------------------------------------------------------------------------------: |

| OPENAI_API_KEY     | string  |     None      |   Yes    |                 [OpenAI token](https://platform.openai.com/account/api-keys)                 |

| OPENAI_BASE_URL    | string  |     None      |    No    |     If using Azure, use: https://{resource}.openai.azure.com/openai/deployments/{model}      |

| OPENAI_MODEL       | string  | gpt-3.5-turbo |   Yes    |                                         OpenAI MODEL                                         |

| AZURE_API_VERSION  | string  |     None      |    No    |                                      AZURE_API_VERSION                                       |

| AI_COMMIT_LANGUAGE | string  |      en       |   Yes    |                                    Supports 19 languages                                     |

| EMOJI_ENABLED      | boolean |     true      |   Yes    |                                   Enable or disable Emoji                                    |

| FULL_GITMOJI_SPEC  | boolean |     false     |    No    | Enable the complete GitEmoji specification, see [https://gitmoji.dev/](https://gitmoji.dev/) |

## ⌨️ Local Development

You can use Github Codespaces for online development:

[![][github-codespace-shield]][github-codespace-link]

Alternatively, you can clone the repository and run the following commands for local development:

```bash

$ git clone https://github.com/sitoi/ai-commit.git

$ cd ai-commit

$ npm install

```

Open the project folder in VSCode. Press F5 to run the project. This will open a new Extension Development Host window and launch the plugin within it.

## 🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what you’re made of.

[![][pr-welcome-shield]][pr-welcome-link]

### 💗 All Thanks To Our Contributors

[![][github-contrib-shield]][github-contrib-link]

## 🔗 Links

### Credits

- **auto-commit** - 

- **opencommit** - 

---

## 📝 License

This project is [MIT](./LICENSE) licensed.

[github-codespace-link]: https://codespaces.new/sitoi/ai-commit

[github-codespace-shield]: https://github.com/sitoi/ai-commit/blob/main/images/codespaces.png?raw=true

[github-contributors-link]: https://github.com/sitoi/ai-commit/graphs/contributors

[github-contributors-shield]: https://img.shields.io/github/contributors/sitoi/ai-commit?color=c4f042&labelColor=black&style=flat-square

[github-forks-link]: https://github.com/sitoi/ai-commit/network/members

[github-forks-shield]: https://img.shields.io/github/forks/sitoi/ai-commit?color=8ae8ff&labelColor=black&style=flat-square

[github-issues-link]: https://github.com/sitoi/ai-commit/issues

[github-issues-shield]: https://img.shields.io/github/issues/sitoi/ai-commit?color=ff80eb&labelColor=black&style=flat-square

[github-license-link]: https://github.com/sitoi/ai-commit/blob/main/LICENSE

[github-license-shield]: https://img.shields.io/github/license/sitoi/ai-commit?color=white&labelColor=black&style=flat-square

[github-stars-link]: https://github.com/sitoi/ai-commit/network/stargazers

[github-stars-shield]: https://img.shields.io/github/stars/sitoi/ai-commit?color=ffcb47&labelColor=black&style=flat-square

[pr-welcome-link]: https://github.com/sitoi/ai-commit/pulls

[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge

[github-contrib-link]: https://github.com/sitoi/ai-commit/graphs/contributors

[github-contrib-shield]: https://contrib.rocks/image?repo=sitoi%2Fai-commit

[vscode-marketplace-link]: https://marketplace.visualstudio.com/items?itemName=Sitoi.ai-commit

[vscode-marketplace-shield]: https://img.shields.io/vscode-marketplace/v/Sitoi.ai-commit.svg?label=vscode%20marketplace&color=blue&labelColor=black&style=flat-square

[total-installs-link]: https://marketplace.visualstudio.com/items?itemName=Sitoi.ai-commit

[total-installs-shield]: https://img.shields.io/vscode-marketplace/d/Sitoi.ai-commit.svg?&color=greeen&labelColor=black&style=flat-square

[avarage-rating-link]: https://marketplace.visualstudio.com/items?itemName=Sitoi.ai-commit

[avarage-rating-shield]: https://img.shields.io/vscode-marketplace/r/Sitoi.ai-commit.svg?&color=green&labelColor=black&style=flat-square