Giters

conventional-commits / conventionalcommits.org

The conventional commits specification

Home Page:https://conventionalcommits.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

`feat` is contracted, most other commonly used tags are full words.

mikemaccana opened this issue · comments

commented

In the most common use of this spec the terms are almost always full words, with two exceptions feat and perf

Suggest retiring feat and perf and replace with feature and performance for consistency. perf is outside the scope of this repo though.

TERM FULL WORD
fix ✅
feat 🚫
build ✅
chore ✅
ci (initialization)
docs ✅
style ✅
refactor ✅
perf 🚫
test ✅

Rationale

Searching for feature in commit messages using this spec won't return commits using the term feature, which is a reasonable commit message to add a feature.

commented

Very thoughtful , even in verbal communication while pair programming or while guiding juniors
i have observed that contracted words like feat and perf can create confusion

so it's great idea to make it complete
if needed i can work on this issue @mikemaccana

thank you , have a nice day

commented

The dictionary explains what feat is:

an achievement that requires great courage, skill, or strength

So it can be confused with feature. Please change that feat into a feature 🙏

commented

Very thoughtful , even in verbal communication while pair programming or while guiding juniors i have observed that contracted words like feat and perf can create confusion

so it's great idea to make it complete if needed i can work on this issue @mikemaccana

thank you , have a nice day

commented

The proposed change adds 3 characters to the commit header (thereby substracting them from the commit subject, if one wants to keep it below 72 characters). Those 3 characters are precious, particularly for languages other than English where it's already difficult to fit such limit. I would rather keep feat:

commented

The proposed change adds 3 characters to the commit header (thereby substracting them from the commit subject, if one wants to keep it below 72 characters). Those 3 characters are precious, particularly for languages other than English where it's already difficult to fit such limit. I would rather keep feat:

In that case go with:

  • fe: for the feature
  • fi: for the fix
    etc.

Or, remove the prefix completely from the commit, knowing that the branch the commit is in, already has that prefix anyway, so why repeat yourself? And then, on the squash commit - put that prefix in (which will automatically be added anyway from the PR title) and there will still be a description in the separate lines of the commit message.

Regardless of your or my preferences, the feat means something different than the feature - those are 2 different words.

commented

@javier-godoy How about refactor? It is 8 characters, while feature is 7. 🤔

commented

@Jakub-PMX

@javier-godoy How about refactor? It is 8 characters, while feature is 7. 🤔

refactor is not defined in the conventional commits specification (only fix and feat are).

commented

@Jakub-PMX

@javier-godoy How about refactor? It is 8 characters, while feature is 7. 🤔

refactor is not defined in the conventional commits specification (only fix and feat are).

Claro 👍

commented

Precious characters, indeed. Precious language, nonetheless. I'd vote for full words (i.e. "feature"). I didn't know that "feat" is a word, though.