Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mikemaccana opened this issue Sep 8, 2023 · 9 comments · May be fixed by #566
Open

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

mikemaccana opened this issue Sep 8, 2023 · 9 comments · May be fixed by #566

Comments

@mikemaccana
Copy link

mikemaccana commented Sep 8, 2023

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.

@mikemaccana mikemaccana changed the title feat is contracted, all other tags are full words. feat is contracted, most other commonly used tags are full words. Sep 8, 2023
@purohitdheeraj
Copy link

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

@Jakub-PMX
Copy link

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 🙏

@DoppioJP DoppioJP linked a pull request Jan 26, 2024 that will close this issue
@DoppioJP
Copy link

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

@javier-godoy
Copy link

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:

@Jakub-PMX
Copy link

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.

@Jakub-PMX
Copy link

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

@javier-godoy
Copy link

@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).

@DoppioJP
Copy link

@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 👍

@NikosAlexandris
Copy link

NikosAlexandris commented Apr 4, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants