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

Is there an abbr for improvement? #66

Closed
htchaan opened this issue Jul 9, 2018 · 20 comments
Closed

Is there an abbr for improvement? #66

htchaan opened this issue Jul 9, 2018 · 20 comments
Assignees
Milestone

Comments

@htchaan
Copy link

htchaan commented Jul 9, 2018

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

@damianopetrungaro
Copy link
Member

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
Copy link

pmackay commented Jul 16, 2018

Would improve be an improvement on improvement? ;)

@damianopetrungaro
Copy link
Member

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

Any other suggestion?

@htchaan
Copy link
Author

htchaan commented Jul 19, 2018 via email

@damianopetrungaro
Copy link
Member

@hbetts @stevemao @bcoe wdyt about it?

@hutson
Copy link
Contributor

hutson commented Jul 19, 2018

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
Copy link

pmackay commented Jul 21, 2018

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
Copy link
Contributor

hutson commented Jul 22, 2018

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
Copy link
Member

damianopetrungaro commented Jul 23, 2018

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
Copy link
Contributor

hutson commented Aug 5, 2018

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
Copy link
Member

@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
Copy link
Contributor

hutson commented Aug 19, 2018

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
Copy link
Member

@hbetts I can take a look tomorrow ;)

@damianopetrungaro
Copy link
Member

So after a little research, I found out we may use IMPROV or IMP

@Mouvedia
Copy link

https://en.wikipedia.org/wiki/Imp

@bcoe
Copy link
Contributor

bcoe commented Mar 31, 2019

👋 any objection to closing this pull request, I think the spec appropriately calls out the fact that folks can pick and choose their own types.

@Mouvedia
Copy link

I think we should close this one and reopen #78

@stevemao
Copy link
Member

stevemao commented Apr 1, 2019

Closing now. Feel free to comment.

@batara666
Copy link

wait, so are we using imp: ?

@batara666
Copy link

improve(article/detail): Improve UX

1. Add image placeholder
2. Use cursor: pointer type
3. Remove alert after template selection

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

No branches or pull requests

8 participants