Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

What can we do to optimize our Changelog? #583

Closed
verklov opened this issue Jun 6, 2014 · 5 comments
Closed

What can we do to optimize our Changelog? #583

verklov opened this issue Jun 6, 2014 · 5 comments
Assignees
@verklov

Comments

@verklov
Copy link
Contributor

verklov commented Jun 6, 2014

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?
@verklov verklov self-assigned this Jun 6, 2014
@verklov verklov changed the title Changelog What can we do to optimize our Changelog? Jun 6, 2014
@ihor-sviziev
Copy link
Contributor

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
Copy link
Contributor Author

verklov commented Jun 13, 2014

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

@verklov verklov closed this as completed Sep 5, 2014
@FiveDigital
Copy link 

* 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
Copy link
Contributor

kandy commented Sep 20, 2014

Maybe this link helps you

@FiveDigital
Copy link

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).

magento-team pushed a commit that referenced this issue Sep 10, 2015
Merge pull request #583 from magento-dragons/MAGETWO-40862
6f02d36 
MAGETWO-40565: Improve Sample Data Performance
magento-team pushed a commit that referenced this issue May 4, 2016
Merge pull request #583 from magento-folks/bugs
870bdfb 
[Folks]Bugfix
mmansoor-magento pushed a commit that referenced this issue Nov 11, 2016
@MomotenkoNatalia
Merge pull request #583 from magento-falcons/MAGETWO-60647
d403ec9 
Fixed issues:
- MAGETWO-60647: Delivery of bug fixes for Sample Data and Import/Export
- MAGETWO-56787: [GITHUB][PR] Added call to action to compile command error #4134
- MAGETWO-56786: [GITHUB][PR] Ensure composer.json exists #4121
- MAGETWO-57799: cannot upgrade 2.0 => 2.1 with auto_increment > 1
- MAGETWO-59715: Impossible to import additional_images with labels which have a comma separator
- MAGETWO-60633: [Github] .htaccess deny code execution not working for Apache + php-fpm #6766
- MAGETWO-46636: Nginx doesn't redirect to setup page when using port
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@verklov verklov

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@kandy @ihor-sviziev @FiveDigital @verklov