di-sukharev / opencommit

just a GPT wrapper for git — generate commit messages by an LLM in 1 sec — works best with Claude 3.5 — supports local models too
https://www.npmjs.com/package/opencommit
MIT License
6.19k stars 329 forks source link

[Feature]: Optout of conventional commits and support Gitmoji spec #239

Open stalinkay opened 1 year ago

stalinkay commented 1 year ago

Description

Currently opencommit supports a variant of Conventional Commits and Gitmoji.

This is incompatible with projects that use Gitmoji.

In the context of Gitmoji, the emoji already provides enough context as to what the commit is about. Titles should also use sentence case.

Suggested Solution

This is the correct format of Gitmoji commits.

<intention> [scope?][:?] <message>
 intention: An emoji from the list.
scope: An optional string that adds contextual information for the scope of the change.
message: A brief explanation of the change.

Examples:

✏️ Update the name attribute of 💫 🔧 Change Dependabot interval to monthly ⬆️ Bump prettier from 2.8.8 to 3.0.0 (#1529)

See Gitmoji

Alternatives

No response

Additional Context

No response

github-actions[bot] commented 1 year ago

Stale issue message