Skip to content

Changelog entries for performance improvements #16679

@astrofrog

Description

@astrofrog

Currently, one can only have feature/bugfix/api changelog entries in sub-packages - there is 'other' but it has to be at the root of the package. However, it's not clear where to put performance improvements. They are not really features, and putting them all in 'other' at the root of the changelog entries is not right because they might be attached to a specific sub-package.

  • Option 1: add a new 'perf' changelog type
  • Option 2: allow 'other' entries to be in specific sub-packages

We might also run into this in other respects, for examples adding typing hints to public API might be worth mentioning but are not really features. So perhaps Option 2 makes more sense as we can't create types for every single possible type of change?

Does anyone have any thoughts?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions