Skip to main content

gq config

gq config <NAME> <VALUE>

Description​

Set options. The name is actually the section and the key separated by a dot.

Options​

NAMEVALUEDescription
commit.conventionalBoolEnable Conventional Commits. Default is false.
commit.typesComma separated typesTypes for conventional commits. Default is build, ci, docs, feat, fix, perf, refactor, style, test, revert.
commit.ticketBoolEnable ticket number integration. Default is false.

Examples​

Conventional commits​

You can enable Conventional Commits by running:

gq config commit.conventional true

This setting will make GitQuick ask for a commit type every time you use gq commit. The default types can be changed by running:

gq config commit.types a,b,c

This would change the default types to "a","b","c".

Ticket integration​

If you want your commits to reference a ticket based on the brach name, run:

gq config commit.ticket true

This setting will append a trailer with a ticket number to the commits while using gq commit.

Using gq commit to create docs: add readme file commit message on feature/TEST-123-demo-setup branch will result in the following message:

docs: add readme file

Refs: TEST-123