search

microsoft / PowerToys

Windows system utilities to maximize productivity
MIT License
110.56k stars 6.51k forks source link

[Github] Add keywords to release notes #17515

Closed Jay-o-Way closed 2 years ago

Jay-o-Way commented 2 years ago

Description of the new feature / enhancement

Different companies use different formats for their release notes. We group 'em by module, for example. I think it would be good to start every item with a keyword, like: New, Changed/Improved, Fixed, Removed. It would be good to always list them in a predefined order.

For example:

Always on Top

  • Changed: New sound for Always on Top activation.

Awake

  • New: Temporary duration presets are now configurable.
  • Improved: the system tray icon.
  • Fixed: issue causing Awake to not be closed properly.

ColorPicker

  • New: It's possible to delete multiple colors from the history, or to export a list of colors to a file.
  • Improved: The CIEXYZ format has increased precision.
  • Improved: Performance, by reducing the use of low level keyboard hooks.

P.S. I'm not sure about the added value for the "Highlights" section, it's pretty redundant to me. When I read the list, I can decide for myself what I find important. Alternative: Just mark very important ones with a ⭐ or something.

Scenario when this would be used?

Writing release notes, with a bit more structure, that are easy to (quickly) read/understand :)

Supporting information

Look at https://www.productplan.com/learn/release-notes-best-practices/ https://www.mozilla.org/en-US/firefox/98.0/releasenotes/ https://www.autoitscript.com/autoit3/docs/history.htm for examples

crutkas commented 2 years ago

something we can do better but will be hit / miss.