[Phpmyadmin-devel] Improved release notes - Developers

Mohamed Ashraf

28 Aug 28 Aug

6:30 p.m.

On Wed, Aug 28, 2013 at 11:49 PM, Isaac Bennetch <bennetch(a)gmail.com> wrote:

At the meeting, someone (perhaps even me) suggested improved release notes. Yeah, we all know users should read ChangeLog for changes, but we also know many don't bother. So I've taken it upon myself to draft a suggestion for the upcoming 4.0.6 release. It will require someone (yeah, probably me), to keep up with changes each release and I'm not sure whether that's going to be worth the effort we put in to it. Anyway, the draft I've prepared is https://gist.github.com/ibennetch/ebe1879bcdf9b25212ca please let me know what you think

looks good to me. But I have to ask how is this different from the changelog?

...

------------------------------------------------------------------------------ Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more! Discover the easy way to master current and previous Microsoft technologies and advance your career. Get an incredible 1,500+ hours of step-by-step tutorial videos with LearnDevNow. Subscribe today and save! http://pubads.g.doubleclick.net/gampad/clk?id=58040911&iu=/4140/ostg.cl… _______________________________________________ Phpmyadmin-devel mailing list Phpmyadmin-devel(a)lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/phpmyadmin-devel

-- Mohamed Ashraf

Reply

Michal Čihař

9 Sep 9 Sep

5:27 a.m.

Hi Dne Wed, 28 Aug 2013 21:29:26 -0400 Marc Delisle <marc(a)infomarc.info> napsal(a):

...

Le 2013-08-28 17:49, Isaac Bennetch a écrit :

At the meeting, someone (perhaps even me) suggested improved release notes. Yeah, we all know users should read ChangeLog for changes, but we also know many don't bother. So I've taken it upon myself to draft a suggestion for the upcoming 4.0.6 release. It will require someone (yeah, probably me), to keep up with changes each release and I'm not sure whether that's going to be worth the effort we put in to it. Anyway, the draft I've prepared is https://gist.github.com/ibennetch/ebe1879bcdf9b25212ca please let me know what you think

Maybe we need to talk more about the goal of the release notes.

The biggest goal IMHO is to let users know about big changes more prominently. We can do this either by including in notification mail, adding it to wiki or by putting this into documentation. Some examples: https://docs.djangoproject.com/en/1.5/releases/ http://docs.moodle.org/dev/Moodle_2.5.2_release_notes https://www.mediawiki.org/wiki/MediaWiki_1.22 -- Michal Čihař | http://cihar.com | http://phpmyadmin.net

Reply

Mohamed Ashraf

8:16 a.m.

On Monday, September 9, 2013 at 11:27 AM, Michal Čihař wrote:

...

Hi Dne Wed, 28 Aug 2013 21:29:26 -0400 Marc Delisle <marc(a)infomarc.info> napsal(a):

Le 2013-08-28 17:49, Isaac Bennetch a écrit :

At the meeting, someone (perhaps even me) suggested improved release notes. Yeah, we all know users should read ChangeLog for changes, but we also know many don't bother. So I've taken it upon myself to draft a suggestion for the upcoming 4.0.6 release. It will require someone (yeah, probably me), to keep up with changes each release and I'm not sure whether that's going to be worth the effort we put in to it. Anyway, the draft I've prepared is https://gist.github.com/ibennetch/ebe1879bcdf9b25212ca please let me know what you think

Maybe we need to talk more about the goal of the release notes.

The biggest goal IMHO is to let users know about big changes more prominently. We can do this either by including in notification mail, adding it to wiki or by putting this into documentation. Some examples: https://docs.djangoproject.com/en/1.5/releases/ http://docs.moodle.org/dev/Moodle_2.5.2_release_notes https://www.mediawiki.org/wiki/MediaWiki_1.22

I dont think there should be any bugfixes listed unless its a prominant bug. Same with small features. I believe it should be mostly breaking/major changes/fixes so that it is not the same as the changelog

...

-- Michal Èihaø | http://cihar.com | http://phpmyadmin.net ------------------------------------------------------------------------------ Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more! Discover the easy way to master current and previous Microsoft technologies and advance your career. Get an incredible 1,500+ hours of step-by-step tutorial videos with LearnDevNow. Subscribe today and save! http://pubads.g.doubleclick.net/gampad/clk?id=58041391&iu=/4140/ostg.cl… _______________________________________________ Phpmyadmin-devel mailing list Phpmyadmin-devel(a)lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/phpmyadmin-devel

Reply