https://github.com/myferr/conventional-commit
A CLI made with JavaScript to write nice & neat commit messages that follow the rulesets of Conventional Commits
https://github.com/myferr/conventional-commit
cli commit commits conventional-commits git-tool nodejs util
Last synced: 7 months ago
JSON representation
A CLI made with JavaScript to write nice & neat commit messages that follow the rulesets of Conventional Commits
- Host: GitHub
- URL: https://github.com/myferr/conventional-commit
- Owner: myferr
- License: apache-2.0
- Created: 2025-06-02T05:40:24.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-06-02T06:23:58.000Z (8 months ago)
- Last Synced: 2025-06-02T15:58:55.082Z (8 months ago)
- Topics: cli, commit, commits, conventional-commits, git-tool, nodejs, util
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Conventional Commit
A faster way to commit your changes with a nice, formatted commit message that follows the rulesets of [Conventional Commits](https://www.conventionalcommits.org)
#### Requirements
This project requires you to have a **Google Gemini API Key** and **git** installed locally on your machine
## Installation
```bash
bash <(curl -Ss https://raw.githubusercontent.com/myferr/conventional-commit/refs/heads/main/x.sh)
```
Then restart your shell or run `source ~/{YOUR_CONFIG_FILE}`
> Replace `{YOUR_CONFIG_FILE}` with your config file
> Examples: `.zshrc`, `.bashrc`
## Why?
Using [Conventional Commits](https://www.conventionalcommits.org) is a nice and neat way to make your project's history more readable, automate releases, and maintain cleaner collaboration. Here's why you should use them:
1. Conventional commits follow a structured format like:
```
feat: add user login support
fix: correct typo in signup message
chore: update dependencies
```
2. In a team setting (or your future self), a commit like:
```
fix: handle null values in API response
```
…is much clearer than:
```
update stuff
```
You instantly know what type of change was made, why, and how it affects the project.
3. Your Git log becomes a **narrative** of the project:
```bash
git log --oneline
```
might show:
```
feat: add OAuth support for GitHub
fix: sanitize user input in comment form
docs: add API usage example to README
```
That’s easier to scan than:
```
better auth
fixing things
final README tweaks
```