Comments (7)
I would prefer to see something like enhance
to classify enhancements.
I would argue that development features could be classified as enhancements. IMHO an enhancement classifier would help to bridge the gap between fix and feature. E.g. a fix indicates that there must have been a bug before. A feature indicates that there is some added functionality or business value. But often I find myself to commit changes which improve some situation but which neither fix a bug nor do they add a feature.
E.g. performance usually is a non-functional requirement and can't be classified as a feature from a customer's perspective. Improving performance is usually more of an enhancement than a feature.
from conventionalcommits.org.
We did it some days ago :D #25 !
Thanks to @about-code and @AoDev for the great idea!
from conventionalcommits.org.
I think feat
should be a new feature to your end-user. So if your product is for a business, it'd be a business feature. If your product is a tool, then a feat
is a new feature in your tool, which helps to improve the dev experience of your end-user, developers.
This is also why we don't include things like docs
, ci
or chore
in the changelog, because they have very little to do with your end-users.
From a dev point of view, this could be a new feature.
feat(UI): add super new generic graph visualizer
You might wanna consider build
, ci
or chore
.
from conventionalcommits.org.
It is, indeed, a bit ambiguous about what feat
actually means.
feat: a commit of the type feat introduces a new feature to the codebase for the end-users of your product / library (this correlates with MINOR in semantic versioning).
I agree. And I believe this was the original purpose too. Even with the angular team they are not writing the perfect commit messages.
from conventionalcommits.org.
@stevemao How should we proceed? I think it would be nice to update the meaning on the website.
In practice what I am doing right now in my repos is:
- feat is both "internal dev feature" and "product feature"
- changelog is created with standard-version
- changelog has both product and dev features.
- github release (connected to zappier for product people) gets an edited version of the changelog.
Possibly, I am thinking to introduce a type "internal feature for dev" to stay compliant with the original purpose. This is useful because shared modules / helpers are often in the same codebase but dev are not always aware they got a new tool to use and might reinvent the wheel.
from conventionalcommits.org.
I am not too sure about using build, ci or chore for "unexposed /dev features". But, if feat is meant to be for product level only, then should we reflect this in the definition?
feat: a commit of the type feat introduces a new feature to the codebase for the end-users of your product / library (this correlates with MINOR in semantic versioning).
edit: Look at this angular commit for example:
It does not look as a user facing feature but still it's a "feat". angular/angular.js@2e03aed
feat($parse): add a hidden interface to retrieve an expression's AST
This PR adds a new private method to the$parse
service,$$getAst
,
which takes an Angular expression as its only argument and returns
the computed AST. This feature is not meant to be part of the public
API and might be subject to changes, so use it with caution.
from conventionalcommits.org.
@damianopetrungaro Thanks to @blackxored and you for writing it into the spec!
from conventionalcommits.org.
Related Issues (20)
- e62041900a74d076e1462f7a3e900eb5d7a513e2 HOT 2
- Sign up
- How to configre conventional-changelog-conventionalcommits 7? HOT 1
- `feat` is contracted, most other commonly used tags are full words. HOT 9
- 6_make test.txt
- fix: navigation bar is not responsive on smaller devices HOT 1
- Delete the .idea folder HOT 1
- Decoupling from specific versioning formats (i.e. SemVer) HOT 1
- what is the recommended way to handle deprecations? HOT 2
- Request for Arabic Language Support
- How do I choose a right commit type for adding media content?
- Specification doesn't permit footers without a body HOT 2
- Support Hindi Language HOT 1
- Add clarification for description formatting
- Scheme for documentation
- Should there be (a11y) commit type? How do you address accessibility UI related changes? HOT 1
- GPG key not found HOT 2
- Bad certificate on www.conventionalcommits.org HOT 10
- Ambiguity over footer issue references
- Do we need special types for GitOps commits ?
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from conventionalcommits.org.