https://github.com/liamg/comet

:comet: Command line tool to help you use conventional commit messages (https://www.conventionalcommits.org)
https://github.com/liamg/comet

Last synced: 8 days ago
JSON representation

:comet: Command line tool to help you use conventional commit messages (https://www.conventionalcommits.org)

• Host: GitHub
• URL: https://github.com/liamg/comet
• Owner: liamg
• License: mit
• Created: 2022-03-23T11:48:31.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-05-18T18:59:47.000Z (over 1 year ago)
• Last Synced: 2024-10-23T07:52:39.661Z (17 days ago)
• Language: Go
• Homepage:
• Size: 57.6 KB
• Stars: 116
• Watchers: 2
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - liamg/comet - :comet: Command line tool to help you use conventional commit messages (https://www.conventionalcommits.org) (Go)

README

        
# Comet

Comet is a simple CLI tool that helps you to use [conventional commits](https://www.conventionalcommits.org/) with git.

You can call `comet` where you'd normally type `git commit`. All flags supported in `git commit` will still work.

![Demo](demo.png)

## Installation

Install with Go (1.17+):

```console

go install github.com/liamg/comet@latest

```

Or grab a binary from [the latest release](https://github.com/liamg/comet/releases/latest).

## Customisation

You can customise the options available by creating a `.comet.json` in the root of your repository, or in your home directory. The repository-level config will be preferred if it exists.

The content should be in the following format:

```json

{

  "signOffCommits": false,

  "prefixes": [

    { "title":  "feat", "description":  "a new feature"},

    { "title":  "fix", "description":  "a bug fix"},

    { "title":  "bug", "description":  "introducing a bug"}

  ]

}

```