Commit Genius is a tool to help developers generate perfect Git commit messages following the Conventional Commits standard. It consists of a web application and a Chrome extension.
The web application provides a user interface to generate commit messages.
- Open the
web-app/index.htmlfile in your browser. - Use a Live Server extension in your code editor to serve the file.
- Enter the commit type, description, issue number, and breaking change information.
- Click the "Generate Commit Message" button to generate the commit message.
- Click the "Copy to Clipboard" button to copy the commit message to your clipboard.
The Chrome extension injects a "πͺ Commit Genius" button into GitHub's commit textarea.
- Open Chrome and go to
chrome://extensions/. - Enable "Developer mode" in the top right corner.
- Click "Load unpacked" and select the
browser-extensiondirectory.
- Navigate to a GitHub repository.
- Find the commit textarea.
- Click the "πͺ Commit Genius" button next to the textarea.
- The Commit Genius popup will open.
- Enter the commit type, description, issue number, and breaking change information.
- The generated commit message will be automatically inserted into the commit textarea.
commit-genius/
βββ web-app/
β βββ index.html
βββ browser-extension/
β βββ manifest.json
β βββ popup.html
β βββ popup.css
β βββ popup.js
β βββ contentScript.js
βββ README.md