Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.61 KB

README.md

File metadata and controls

45 lines (28 loc) · 1.61 KB
Raw

GitGPT 🚀

This Visual Studio Code extension leverages the power of OpenAI's GPT-3 model to automatically generate meaningful commit messages based on your code changes. It's designed to streamline the commit process, making it easier for developers to accurately describe their changes and maintain a clean and understandable commit history. 📚

Features 🛠️

  • Automatically generates commit messages based on your code changes.
  • Streamlines the commit process.
  • Helps maintain a clean and understandable commit history.

How to Use 📖

  1. Install the extension in Visual Studio Code.
  2. Open your project in Visual Studio Code.
  3. Stage your changes in Git.
  4. Click on the "Generate Commit Message" icon in the status bar.
  5. If prompted, enter your OpenAI key.
  6. The extension will generate a commit message based on your changes and open it in a new tab.

Requirements 📋

  • Visual Studio Code
  • Git
  • OpenAI key

Known Issues ❗

  • The OpenAI API has a maximum input length of 4096 characters. If your diff is larger than this, it will be truncated.

License 📄

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Acknowledgments 🙏

  • This extension uses the OpenAI API to generate commit messages.
  • Thanks to the Visual Studio Code team for creating a great editor!

Contributing 🤝

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

Show your support ⭐

Give a ⭐️ if this project helped you!