Code Monkey home page Code Monkey logo

ai_commitmessage's Introduction

header

๐Ÿš€ AI Commit Message - Say Goodbye to Commit Message Struggles! ๐Ÿค–โœจ

Welcome to the AI Commit Message extension for VS Code - your ultimate companion for crafting perfect commit messages effortlessly! ๐Ÿ“๐Ÿ’ก Harness the power of artificial intelligence to generate compelling and informative commit messages that accurately describe your code changes. ๐Ÿง ๐Ÿ’ฌ

๐ŸŒŸ Features

  • ๐ŸŽจ Seamless Generation: Generate commit messages with a single click on the 'Generate AI commit' button in the source control tab.

Example of usage

๐Ÿ’ก Tip: You can also generate commits from the command palette by calling the 'Generate AI commit' command.

  • โš™๏ธ Customizable Settings: Tailor the extension to your preferences with a range of configurable settings.
  • ๐ŸŽญ Appearance: Customize the delimiter between commit lines.
  • ๐ŸŒ General: Choose your preferred generator (ChatGPT) and message approval method (Quick pick or Message file).
  • ๐Ÿ”‘ OpenAI: Configure your OpenAI API key, GPT version, custom endpoint, temperature, and max tokens.

๐Ÿ“‹ Requirements

To unleash the full potential of AI Commit Message, you'll need an OpenAI API Key. Get yours from OpenAI and let the magic begin! ๐Ÿ”‘โœจ

๐ŸŽจ Extension Settings

AI Commit Message offers a range of settings to customize your experience:

Appearance ๐ŸŽญ

  • aicommitmessage.appearance.delimeter: Delimiter between commit lines.

General ๐ŸŒ

  • aicommitmessage.general.generator: Generator used to create commit messages. Available options: ChatGPT.

  • aicommitmessage.general.messageApproveMethod: Method used to approve generated commit messages. Available options: Quick pick, Message file.

  • aicommitmessage.openAI.apiKey: OpenAI API Key. Needed for generating AI commit messages

  • aicommitmessage.openAI.gptVersion: Version of GPT used by OpenAI

  • aicommitmessage.openAI.customEndpoint: Enter "openai" or "perplexity" or enter a custom endpoint URL.

  • aicommitmessage.openAI.temperature: Controls randomness. Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive

  • aicommitmessage.openAI.maxTokens: The maximum number of tokens to generate. Requests can use up to 2048 tokens shared between prompt and completion

  • aicommitmessage.openAI.language: The language of the prompt. The default language is English (en).

๐Ÿ“ Release Notes

1.0.5

  • Added advanced configuration for ChatGPT.
  • Introduced option to accept and edit generated commits via temp message file. (Thanks, chenweiyi!)
  • Added option to set custom ChatGPT endpoint URL. (Thanks, aiyogg!)
  • Fixed issue with git on Windows (Issue #5).
  • Added option to select different ChatGPT versions (Issue #6).
  • Set default ChatGPT version to gpt-4.

1.0.4

  • Updated commit formatting.
  • Added new setting.

1.0.3

  • Added OpenAI API Key input prompt.

1.0.2

  • Fixed UX.

1.0.1

  • Updated icons.

1.0.0

  • Initial release of AI Commit Message.

๐Ÿ“œ License

Released under MIT by @dmytrobaida.


Elevate your commit game to new heights with AI Commit Message! Let's make commit messages great again! ๐Ÿš€๐ŸŒŸ

ai_commitmessage's People

Contributors

combba avatar dmytrobaida avatar sgwannabe avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.