Giter Site home page Giter Site logo

Comments (4)

masukomi avatar masukomi commented on May 22, 2024

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.

olivierlacan avatar olivierlacan commented on May 22, 2024

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.

jokeyrhyme avatar jokeyrhyme commented on May 22, 2024

Sounds good. Changed it is!

from keep-a-changelog.

matteoolivi avatar matteoolivi commented on May 22, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.