https://github.com/matthewbub/conventional-commit-helper

shell script to assist with conventional commits
https://github.com/matthewbub/conventional-commit-helper

conventional-commits git shell

Last synced: over 1 year ago
JSON representation

shell script to assist with conventional commits

• Host: GitHub
• URL: https://github.com/matthewbub/conventional-commit-helper
• Owner: matthewbub
• License: mit
• Created: 2020-12-26T15:20:01.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-08-07T17:33:02.000Z (almost 3 years ago)
• Last Synced: 2025-03-17T23:41:44.645Z (over 1 year ago)
• Topics: conventional-commits, git, shell
• Homepage:
• Size: 3.25 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# conventional-commit-helper

[![MIT](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE)

A bash script to assist [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).

With **conventional-commit-helper**

```bash

$ commit "this is my commit"

```

Behind the scenes

```bash

$ git add .

$ git status

$ git commit -m "TYPE: this is my commit"

```

![use case](./public/use.gif)

## Setup

- [x] [Ensure  `PATH=~/bin:$PATH` is in your bash config.](https://unix.stackexchange.com/questions/26047/how-to-correctly-add-a-path-to-path)

- [x] Move the [`commit`](https://github.com/hi-matbub/conventional-commit-helper/blob/main/commit) file to the root of your desired repo.

- [x] [Init (first time only)](https://askubuntu.com/questions/443789/what-does-chmod-x-filename-do-and-how-do-i-use-it)

```bash

$ chmod +x ./commit

```

- [x] **Execute**

```bash

$ ./commit "commit message here"

```