Comments (4)
Two things:
I would suggest that "method() does x" is generally too detailed for a change log. A change log entry shouldn't be that tied to the implementation (personal opinion of course). You want it to be something you can give to end users not people deep in the weeds. For example:
- Reduced memory usage in core method(s)
- Reduced run time by 30% on 2012 MacBooks
The doc specifies an "added", "changed", and "removed" section. What you've proposed is neither adding, nor removing, and it's absolutely a change... so "changed" is where it goes. I see no reason that doesn't adequately contain performance changes.
from keep-a-changelog.
I think I agree with @masukomi.
Just think of it as changed X to improve performance
.
Therefore:
### Changed
- Reduced memory usage in core method(s)
- Reduced run time by 30% on 2012 MacBooks
The only exception in the guidelines is "Security" because those changes should stand out dramatically. Performance improvements are nice to have, but I think it's a bad idea to dilute attention with one more sub-section when really performance improvements can fit in either: Added
, Changed
, Fixed
, or Removed
.
from keep-a-changelog.
Sounds good. Changed
it is!
from keep-a-changelog.
Overlapping (perhaps duplicate) discussion: #333 .
@olivierlacan I see your point that a standalone performance section might be an overkill. Not sure if it changes your mind (I'm undecided too), but I think you're being optimistic in considering only performance improvements. Those are nice to have, but performance regressions are more important to signal in my opinion.
from keep-a-changelog.
Related Issues (20)
- Inconsistency in the use of the period at the end of changes HOT 3
- I recommend this date format HOT 2
- Nu Html Checker: Improve Html Quality HOT 4
- Webbkoll: Security suggestions
- PageSpeed Insights: Accessibility
- PageSpeed Insights: Performance HOT 1
- Types of changes - Set order HOT 1
- Types of changes - Add missing types to the example CHANGELOG.md HOT 1
- use GitHub labels or split off to separate repo to differentiate between issues HOT 2
- Bad link to web designer HOT 1
- [question] about changelog "rules"
- Broken link to ISO 8601 date standard HOT 2
- [question] changelog structure HOT 2
- Changelog ideas
- Parser, converter and json/yaml with dictionary
- Keep a Changelog link in example changelog is out of date HOT 4
- Seemingly GitHub links are broken HOT 3
- Link to ISO date standard is broken; has a trailing ")" HOT 3
- Version 1.1.1 not visible at website keepachangelog.com HOT 2
- Changelog available sections HOT 2
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 keep-a-changelog.