https://github.com/sina-byn/gitt

https://github.com/sina-byn/gitt

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/sina-byn/gitt
• Owner: sina-byn
• License: mit
• Created: 2024-06-23T10:35:23.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T05:36:59.000Z (2 months ago)
• Last Synced: 2024-08-29T06:39:14.476Z (2 months ago)
• Language: JavaScript
• Size: 18.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gitt 

a CLI that helps you write better commit messages

Please consider following this project's author, [Sina Bayandorian](https://github.com/sina-byn), and consider starring the project to show your :heart: and support.

## Table of Contents

- [Usage](#usage)

- [Commit Types](#commit-types)

- [Examples](#examples)

## Usage

Clone the repository :

```sh

git clone https://github.com/sina-byn/gitt.git

```

Install dependencies :

```sh

cd gitt && npm i

```

Build :

```sh

npm run build

```

Initialize :

```sh

npx gitt

```

To use globally :

```sh

npm i -g .

```

Then use wherever you want :

```sh

gitt  

```

`?` : optional argument

## Commit Types

| Commit Type |  |

|---|---|

| feat | New Feature |

| fix | Fixing Bugs |

| chore | Miscellaneous Changes |

| refactor | Code Refactoring |

| docs | Documentation Updates |

| style | Code Formatting |

| test | Testing Updates |

| perf | Performance Improvements |

| ci | Continuous Integration |

| build | Build System Updates |

| revert | Reverting Chanegs |

## Examples

 

```sh

gitt

```

```sh

gitt feat

```

```sh

gitt fix "bug fixed"

```