mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2026-03-22 21:24:02 -05:00
Inconsistency in types #15
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @doodlewind on GitHub (Jan 20, 2018).
Two minor confusion points in commit types:
typefield is specified as a verb, whereasfeatitself is a noun, and so doeschore,style,perf, etc.fix:,feat:, while its definition is<type>[optional scope]:, which excludes colon from type name.Feel free to close this issue if it's too captious 😅
@damianopetrungaro commented on GitHub (Jan 20, 2018):
About the 2 you are not excluding the colon from the type, just moving it at the end of type+scope definition.
About the one i agree, we can also think about the difference between
featandimprove, and rename them so that they may be more explicit.For example in my company we are using conventional commits, and sometimes we have some issue about
featmeaning.improvemay fit better the case (also another verb but this one is the more generic), because it is not a feature, the are not improving the performance, we are not refactoring but we are improving the implementation of the functionality.@damianopetrungaro commented on GitHub (Jan 20, 2018):
I think it's related also to #28. We can change in a more explicit and clear way.
@stevemao commented on GitHub (Jan 22, 2018):
It's definitely a noun not a verb. PR welcome.
I don't really understand this and it seems correct to me. Maybe @damianopetrungaro got the point.
@doodlewind commented on GitHub (Jan 22, 2018):
@stevemao the formal definition is
<type>[optional scope]:, so I guessfeatis a valid type whilefeat:may not? See also json spec, itspairconsists ofstring : value, so in a captious way,stringis valid instead ofstring:.@stevemao commented on GitHub (Jan 22, 2018):
featis a type,:is just a separator. when thescopeis omitted, it looks likefeat: short description. Its the same asfeat(): short descriptionorfeat(*): short description@stevemao commented on GitHub (Jan 22, 2018):
I've seen all three forms in the angular project. Maybe we should recommend one of them? cc @bcoe
@damianopetrungaro commented on GitHub (Jan 22, 2018):
@stevemao and @doodlewind wdyt about split
featinimproveand another verb foradd a feature(@doodlewind any suggestion?)So that we have both the use cases separated and well defined?
@stevemao commented on GitHub (Jan 22, 2018):
@damianopetrungaro I'm open to suggestions on that. The angular convention was designed for non monorepos and
featwas just meant to be for end users. In a monorepo this could be confusing.