Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

chore(CHANGELOG): introduce perf() section for performance-related commits #5312

Closed
wants to merge 1 commit into from

Conversation

matsko
Copy link
Contributor

@matsko matsko commented Dec 6, 2013

Instead of using fix() or chore() when labelling a commit which improves
speed or performance use perf(). Perf commits will be listed in the
CHANGELOG under "Performance Improvements".

For example:
perf($animate): cache all getComputedStyle operations to reduce additional reflows

@mary-poppins
Copy link

Hi Matias!

@IgorMinar
Copy link
Contributor

lgtm.

please also update the commit message conventions doc linked from Contributing doc

…mmits

Instead of using fix() or chore() when labelling a commit which improves
speed or performance use perf(). Perf commits will be listed in the
CHANGELOG under "Performance Improvements".

For example:
perf($animate): cache all getComputedStyle operations to reduce additional reflows
@matsko
Copy link
Contributor Author

matsko commented Dec 6, 2013

@IgorMinar done.

@petebacondarwin
Copy link
Contributor

@petebacondarwin
Copy link
Contributor

BTW, I always assumed that such performance related commits went under "refact"?

@IgorMinar
Copy link
Contributor

I'm sorry, but I wasn't able to verify your CLA signature. CLA signature is required for any code contributions to AngularJS.

Please sign our CLA and ensure that the CLA signature email address and the email address in this PR's commits match.

If you signed the CLA as a corporation, please let me know the company's name.

Thanks a bunch!

PS: If you signed the CLA in the past then most likely the email addresses don't match. Please sign the CLA again or update the email address in the commit of this PR.
PS2: If you are a Googler, please sign the CLA as well to simplify the CLA verification process.

@mgol
Copy link
Member

mgol commented Dec 9, 2013

This would be great. I submitted a PR labeled feat as it introduces a new jqLite method but the only reason for that is a huge perf gain: #4457

I can imagine that this PR didn't get much attention because of this feat label that made it look not so serious where in fact this improves performance a lot.

Having such things labeled as perf might help them to get more attention.

@Narretz
Copy link
Contributor

Narretz commented Dec 9, 2013

Can't this be included in refactor?

@matsko
Copy link
Contributor Author

matsko commented Dec 9, 2013

We thought about that, but I believe refactor, chore and all other uncommon subjects are stripped in the CHANGELOG. The point is to include a separate section for performance-related improvement since so much work may go into them, but the community ends up having no idea that they were in a release.

@matsko
Copy link
Contributor Author

matsko commented Dec 9, 2013

@IgorMinar @petebacondarwin done (both of them).

@matsko
Copy link
Contributor Author

matsko commented Dec 9, 2013

MERGED

@matsko
Copy link
Contributor Author

matsko commented Dec 9, 2013

Landed as a14266e

@matsko matsko closed this Dec 9, 2013
@matsko matsko deleted the perf_changelog branch December 9, 2013 16:55
@Narretz
Copy link
Contributor

Narretz commented Jan 28, 2014

just stumbled upon this google doc: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit?pli=1 (Git Commit Message Conventions
) If this is still relevant, 'perf' should be added to it.

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

Successfully merging this pull request may close these issues.

6 participants