• Resolved Ambyomoron

    (@josiah-s-carberry)


    Is there a site with more explanatory information about the updates? The laconic phrases in the change log might provide a taste of what changes, but do not really allow for understanding.

Viewing 3 replies - 1 through 3 (of 3 total)
  • Plugin Author Kevin Pirnie

    (@kevp75)

    Hey mate. At this point there is not. I will be putting out a couple of blog posts about this and my other plugins, I just have not had time to.

    What more specifically would you be looking for in the change log?

    Thread Starter Ambyomoron

    (@josiah-s-carberry)

    I’ll look out for what you post.

    In the change log I would look for enough information to help determine what needs to be tested in the new version or what configuration changes might be needed.

    It is very helpful to see each point classified, such as “bug fix”, “new feature”, “tweak of existing feature”, etc.

    Some change logs cross-reference the relevant records in whatever tool you use to manage development, if that is visible by the public.

    But, in general, whatever information makes life simpler for the user is appreciated. For example, in 1.8.23, instead of “Updated minimum PHP requirement”, say what the new minimum version is. In 1.9.11, “Attempt to override existing headers” is a little vague. Which headers defined where? In 1.9.18, “Publishing” doesn’t really say much…

    Plugin Author Kevin Pirnie

    (@kevp75)

    Mmm… certainly food for thought. I can explain 1.9.18 ??
    I had an issue where I forgot to update the version in the readme for 1.9.17, so it was still showing as 1.9.11

    So… for example, 1.9.11, it would be worth repeating what headers are set by the plugin itself?

    I appreciate the input mate… I’ll see what I can do for future versions.

Viewing 3 replies - 1 through 3 (of 3 total)
  • The topic ‘Documentation of changes’ is closed to new replies.