What can we do to optimize our Changelog?

[verklov]

Hey guys,
Just got some feedback from Meet Magento Germany. People say they would like to have changelog prepared in a bit different manner.

In particular, as far as I understood, our current changelog is too granular providing unnecessary details while people would like to see major changes not to get sunk under the tons of details.

Please share your vision and suggestions on our changelog in the comments.

Here is what I suggest so far:
We may try providing some general messages in the changelog while still have the complete description (as it is now published in the changelog) for each released version in the wiki articles.

What do you think?

[ihor-sviziev]

Would be great some wiki for architecture changes describe.
Example:

• build 2.0.0.0-xxx
  • refactored price.phtml file.

Description how it was before

Description how it works now.

[verklov]

Thank you for the suggestion, @igor-svizev! Anyone else? Any other ideas?

[FiveDigital]

* Price template refactoring
   * Introduced a single interface for price and tax calculation logic

Where? How? Perhaps you can add more information like the affected classes and templates?

[kandy]

Maybe this link helps you

[FiveDigital]

Well my idea was to just have a hint in the changelog where you can find the change. The commit log says Sorry, we could not display the entire diff because too many files (661) changed. so it's pretty hard to find the new interface for price and tax calculation in that commit. I know it's not impossible but it would save a lot of time when the changelog points you to the affected class(es) or template(s).