Skip to content

vstacked/commit_convention

Repository files navigation


Markdownify
Commit Convention

A commit conventional tools desktop app built on top of Electron.

Electron Electron

Key FeaturesHow To UseDownloadKeyboard ShortcutsLicense

demo

with Gemini 🎉

demo-gemini

Note: to using this feature, please generate your own key at Google AI Studio

Key Features

  • Write commit messages quickly with a tap/click interface
  • Autocomplete suggestions based on your commit history
  • Flexible Copy Options
    • Copy commit messages as plain text
    • Copy as complete Git commit commands for easy pasting in terminal
  • Project Profiles
    • Create and manage multiple profiles for different projects
    • Customize commit types and templates for each profile
  • History Management
  • Integrated with Gemini AI to review and revised your commit message

How To Use

To clone and run this application, you'll need Git, yarn and Node.js installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/vstacked/commit_convention.git

# Go into the repository
$ cd commit_convention

# Install dependencies
$ yarn install

# Run the app
$ yarn run start

Download

You can download the latest installable version of Commit Convention for Windows.

Keyboard Shortcuts

Command Key
Select / Unselect type feat ctrl1
Select / Unselect type fix ctrl2
Select / Unselect type refactor ctrl3
Select / Unselect type perf ctrl4
Select / Unselect type style ctrl5
Select / Unselect type test ctrl6
Select / Unselect type docs ctrl7
Select / Unselect type build ctrl8
Select / Unselect type chore ctrl9
Select / Unselect type ops ctrl0
Trigger autocomplete ctrlspace
Close autocomplete & Profile(s) window Esc
Autocomplete select move down Arrow Down
or
ctrlj
Autocomplete select move up Arrow Up
or
ctrlk
Autocomplete apply selected Enter

License

MIT

About

A commit conventional tools, but GUI

Resources

License

Stars

Watchers

Forks

Packages

No packages published