Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robvanderleek/gh-cc

GH CLI extension for Conventional Commits
https://github.com/robvanderleek/gh-cc

cli gh gh-extension terminal

Last synced: 22 days ago
JSON representation

GH CLI extension for Conventional Commits

Host: GitHub
URL: https://github.com/robvanderleek/gh-cc
Owner: robvanderleek
License: isc
Created: 2024-10-16T17:46:46.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-10-25T12:18:59.000Z (2 months ago)
Last Synced: 2024-12-06T08:35:47.015Z (26 days ago)
Topics: cli, gh, gh-extension, terminal
Language: Shell
Homepage:
Size: 219 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md

Awesome Lists containing this project

README

# GH Extension: Conventional Commits

> Extension for the GitHub CLI that makes every commit a Conventional Commit.

![demo](docs/demo.gif)

# What is this?

[Conventional Commits](https://www.conventionalcommits.org/) is a convention
developers use to indicate the meaning of a git commit. For example, if a
commit fixes a bug in the code, your conventional commit message would look
something like this:

```shell
fix: 🐛 Do not crash on empty index field
```

or if your commit updates a project's documentation your conventional commit would look like:

```shell
docs: 📝 Update FAQ section
```

This GH CLI extension helps to extend every `git commit` commit message with a
conventional commit prefix.

# Installation

```shell
gh ext install robvanderleek/gh-cc
```

## upgrade

```shell
gh ext upgrade robvanderleek/gh-cc
```

## uninstall

```shell
gh ext remove robvanderleek/gh-cc
```

# Usage

Make sure you have the [GitHub CLI](https://cli.github.com/) up and running.
Next, install the extension (see above), and type the following inside any
cloned repository:

```shell
gh cc -am "commit message here"
```

This extension passes all arguments on to `git commit`, so to save typing you
can add the following alias to your shell configuration: `alias gc="gh cc"`.
The command above then becomes:

```shell
gc -am "commit message here"
```

That's it!

# Configuration

None yet, do you want to configure anything? Please open an issue for it!

# Feedback, suggestions and bug reports

Please create an issue here: https://github.com/robvanderleek/gh-cc/issues

If you like this software, please star :star: it.

# Contributing

If you have suggestions for how this extension could be improved, or want to
report a bug, [open an issue](https://github.com/robvanderleek/gh-cc/issues)!
All and any contributions are appreciated.

# License