Is there an abbr for `improvement`?

[htchaan]

Since improvement(11 chars) is even longer than feature (7 chars), which is shortened as feat.

[damianopetrungaro]

Hey @htchaan thank you for the question!

I think it's quite long too, but at the moment there's no abbreviation for improvement, if you have a good idea feel free to suggest and discuss here in the issue!

Good ideas are always welcome 😄

[pmackay]

Would improve be an improvement on improvement? ;)

[damianopetrungaro]

@pmackay I think improve is more a verb than a noun.

Any other suggestion?

[htchaan]

I vote for `impr`. Its 4-char just like many other abbreviations eg. `elem`, `feat`, `impl`. Damiano Petrungaro <notifications@github.com> 於 2018年7月19日週四 上午12:49寫道：

…

@pmackay <https://github.com/pmackay> I think improve is more a verb than a noun. Any other suggestion? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#66 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACSbWf9sj76KhfntefJU2OWnb5mbImq5ks5uH2cvgaJpZM4VHNnY> .

[damianopetrungaro]

@hbetts @stevemao @bcoe wdyt about it?

[hutson]

I didn't realize we recommended improvement.

We also recommend improvement for commits that improve a current implementation without adding a new feature or fixing a bug

Honestly, if it's a code change, then the only non-feature, non-bug, improvement would be a performance one, and for that you could use the Angular convention of perf.

Basically, I'm taking a step back and asking, do we even need improvement? What does it communicate that feat, fix, and perf, do not?

[pmackay]

Basically, I'm taking a step back and asking, do we even need improvement? What does it communicate that feat, fix, and perf, do not?

What would a refactoring for code cleanup fit under?

[hutson]

What would a refactoring for code cleanup fit under?

The Conventional Commits documentation states: for example commitlint-config-conventional (based on the the Angular convention) recommends chore:, docs:, style:, refactor:

So I personally use refactor, and the communities I work with use refactor, for code changes that do not add a feature, address a bug, or improve performance.

[damianopetrungaro]

Hey!
Sorry but I had a weekend without internet 😄

@hbetts I suggested some months ago to introduce improvement, because refactor means it MUST NOT introduce any breaking changes.

Instead improvement it's ok with API changes but does not introduce any external BC.

I am totally open to rediscuss it!

---

edit:
btw, just to underline the concept, we should not stick 1:1 to the Angular convention, we are inspired by, not equals to 😄

The Conventional Commits documentation states: for example commitlint-config-conventional (based on the the Angular convention) recommends chore:, docs:, style:, refactor:

[hutson]

because refactor means it MUST NOT introduce any breaking changes.

I think I've used refactor in the past for breaking changes.

For example, I will deprecate a function as part of a patch, but I won't remove it.

Then, at a later time, I will remove that function in a refactor, with a BREAKING CHANGE comment at the bottom of my commit message, explaining the removal, and the recommended migration path. I use refactor because I'm not adding a feature, and I don't consider removing a deprecated function as a bug fix.

I'm sorry if I'm derailing this issue. If y'all would like my thoughts on improvement, or additional personal examples, please let me know where I can post them.

---

As for abbreviation, yes, I would be fine with the recommendations. In particular, impr, because I kind of agree with @damianopetrungaro about the other being more of a verb.

Any way to quantify the common abbreviated form of improvement as used by English language writers?

[damianopetrungaro]

@hbetts I'm totally fine about talking about it, our mission is to make the specs as better as possible 😄

As you can see I do not agree with the usage of refactor with a BREAKING CHANGE: into it, it's a contradiction imho 😄

---

Looking forward to any English native speaker about it

Any way to quantify the common abbreviated form of improvement as used by English language writers?

[hutson]

I've spun off a discussion about improvement into #78

As for this issue, I don't have the time to research whether impr is the common abbreviation of improvement.

Does anyone else have time?

[damianopetrungaro]

@hbetts I can take a look tomorrow ;)