Better release notes please

  • Resolved ferns

    (@ferns)


    7 years, 6 months ago

    In the last couple of days the plugin has caused some major issues (as in ‘bringing websites down’ level of severity).

    I appreciate that you fixed it quickly, but your release information sucks.

    The notes are useless for decision making.

    Eg.
    1.16.1
    2017-05-08
    [TWEAK] Added PHP version requirements

    As a user, I have no idea from that if you have fixed the problem from v1.16, and as you know, users are now having issues because they have the wrong version of PHP (and there was no way to prevent this because your notes contain no information about new requirements).

    Something like this would have been much more useful:
    1.16.1
    2017-05-08
    [FIXED] Bug causing errors on site load
    [CHANGE] PHP version 5.5 now required (previous 5.nn)

Viewing 4 replies - 1 through 4 (of 4 total)

  • This is indeed a problem, but it’s not just that the release notes are inadequate. The underlying problem is thinking it’s appropriate to change the PHP requirement in an update from 1.16 to 1.16.1.

    Plugin Author Craig Hewitt

    (@podcastmotor)

    Hi Ferns and Stickster,

    Thank you for the message and I think you’re spot on with the room for improvement with us giving some more details around the requirements for PHP 5.5 on the latest release.
    We are looking at some ways to include previous versions of PHP as we speak and I hope to be able to bring those out as an update soon.

    Plugin Contributor Jonathan Bossenger

    (@psykro)

    Hi @ferns and @stickster

    Thank you for your feedback, I will ensure to provide more clear release notes in future releases.

    Ritter Knight

    (@thundermarketing)

    Yeh we have a client on an ancient CentOS version running PHP 5.3. I know, PHP 5.3 is basically dead but it’s not in our control to update their stack. This update basically renders this plugin useless. We’ve downgraded but a little more heads-up would have been nice.

    As stickster mentioned, it’s really an amateur move to change the PHP requirement in a point release. Maybe we’re old school but this is the kind of a thing that you change in a 2.0 release. I usually don’t write negative reviews but this is the kind of thing that I’d give 1 stars on the repo for.

Viewing 4 replies - 1 through 4 (of 4 total)
  • The topic ‘Better release notes please’ is closed to new replies.