https://github.com/ivanatias/commits-assistant-cli
A commits assistant CLI built using Go to enforce conventional commits within a project
https://github.com/ivanatias/commits-assistant-cli
Last synced: about 2 months ago
JSON representation
A commits assistant CLI built using Go to enforce conventional commits within a project
- Host: GitHub
- URL: https://github.com/ivanatias/commits-assistant-cli
- Owner: ivanatias
- Created: 2023-06-16T20:52:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-05T23:26:15.000Z (almost 2 years ago)
- Last Synced: 2025-02-07T16:46:58.494Z (4 months ago)
- Language: Go
- Size: 16.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Git Commits Assistant
Command-line interface (CLI) tool built with Go that helps enforce conventional commit styles within a project. It makes it easy to add properly formatted and structured commits so that team members can quickly understand the changes being made.
## Installation
To install, follow these steps:
- Clone the repository: `git clone https://github.com/ivanatias/commits-assistant-cli.git`
- Navigate to the cloned directory: `cd commits-assistant-cli`
- Build the tool using Go: `go build -o gca main.go`
### Important:
You must install Go in your system. To install, follow the instructions on [Go's website](https://go.dev/doc/install).
## Usage
Once installed, you can start using the commits assistant by running `./gca` in your terminal.
The assistant will guide you through the process.