The other day I was notified by the iOS App Store that two of my apps had available updates. I always get excited when updates come. “Is it new features? Long standing annoyances fixed? Performance boosts?” All to often though this is all I see:

bug-fixes

“- Bug Fixes” is possibly my biggest pet-peeve practice of software developers. Great you fixed some stuff. Was it 1 bug or 100 bugs? Were they security related? Is it the bug I told your support staff about months ago? I’ll never know because of this changelog. One thing that a professional developer does is take ownership of their code. If you made the mistake, take the blame. Changelog transparency is just one way of doing this. Being clear about what you change leads to being clear about what you have/are doing.

How embarrassing…

Look, as a developer I get it. Sometimes your bug fixes are because you did something you find “stupid”, and that’s embarrassing. Misspelling a variable or function name, not verifying a data set, or just general mistakes sometimes sneak their way into a commit. That happens. But why hide the fact that you aren’t perfect? You don’t have to go into details, but you could explain what your bug fix…well…fixes! That’s a novel idea. Transparency in your mistakes.

Identify new bugs

One other reason to be more clear of your “bug fixes” is to allow new bugs to be identified easier. If your new code introduces a bug, having a list of items you did in the last release might help you narrow down your debugging window. One of the primary focuses of change management is logging every change. If something goes wrong during a deployment or release, giving proper information can help avoid hours of lost time tracking down a bug.

When did we add that one feature that does that one thing?

If your a developer who iterates quickly, you might easily forget when you made a specific change or added a new feature. Here comes the changelog to the rescue. I prefer to list each item in my change log with one of the following:

  • FIX – For bug fixes
  • NEW – For new features
  • ENHANCEMENT – For smaller updates to current features

So let’s try and give our users and other developers a little more transparency when we push a new release and avoid using ‘Bug Fixes’ in our changelogs. Here are two changelogs for WordPress plugins that you can take examples from:

WordPress SEO by Yoast
Easy Digital Downloads

Posted by Chris Klosowski

Chris Klosowski is the Director of Technology at Sandhills Development, LLC, creators of fine WordPress plugins, and ecommerce solutions.

39 Comments

  1. it shows that you are, in fact, a human. :O

    Reply

  2. cialis 1000 mg – cialis drug female cialis canada

    Reply

  3. womens viagra pill viagra review xtpwzho – where to get viagra

    Reply

  4. azithromycin zithromax generic zithromax – zithromax price south africa

    Reply

  5. stromectol 3 mg dosage stromectol for sale – stromectol ivermectin

    Reply

  6. price of lipitor in india lipitor generic – lipitor generic australia

    Reply

  7. Way cool! Some extremely valid points! I appreciate you
    penning this article and the rest of the site
    is extremely good.

    Reply

  8. ed therapy foods for ed – male erection pills

    Reply

  9. hims ed pills ed meds pills drugs – natural treatments for ed

    Reply

  10. When I initially commented I clicked the “Notify me when new comments are added” checkbox and now each time a comment is added I get four emails with the same comment.
    Is there any way you can remove me from that service?
    Bless you!

    Reply

  11. canadian pharmacy cialis no prescription cialis no prescription canada – buy generic cialis australia

    Reply

  12. What’s up, constantly i used to check blog posts here in the early hours
    in the daylight, for the reason that i like to gain knowledge of more and more.

    Reply

  13. 5 mg prednisone daily buy prednisone – order prednisone 10mg

    Reply

  14. Thank you for the auspicious writeup. It in fact was a amusement account
    it. Look advanced to far added agreeable from you!
    However, how can we communicate?

    Reply

  15. Do you mind if I quote a couple of your articles as long as I provide credit and sources back to your
    blog? My blog site is in the very same area of interest as
    yours and my visitors would really benefit from a lot of the information you present here.
    Please let me know if this ok with you. Thanks a lot!

    Reply

  16. Hi there, this weekend is pleasant for me, because this moment i am reading
    this impressive informative piece of writing here at my residence.

    Reply

  17. ivermectin over the counter canada ivermectin for humans where to buy – ivermectin 6mg

    Reply

  18. Generally I do not read article on blogs, but I wish to say that this
    write-up very pressured me to check out and do it!
    Your writing taste has been amazed me. Thanks, quite nice
    article.

    Reply

  19. This site was… how do you say it? Relevant!! Finally I’ve found something which helped
    me. Cheers!

    Reply

  20. ivermectin oral 0 8 ivermectin for humans where to buy – stromectol usa

    Reply

  21. I don’t know if it’s just me or if perhaps everyone else encountering problems with your site.

    It looks like some of the written text on your posts are running off
    the screen. Can somebody else please comment and let me know if
    this is happening to them as well? This may be a issue with my web browser
    because I’ve had this happen before. Kudos

    Reply

  22. Fastidious response in return of this issue with genuine arguments and explaining all regarding that.

    Reply

  23. cialis results cialis no prescription canada – cialis from usa

    Reply

  24. best place to buy viagra online viagra over the counter – viagra over the counter walmart

    Reply

  25. discount cialis from india cialis no prescription canada – cialis indien bezahlung mit paypal

    Reply

  26. Very good blog! Do you have any recommendations for aspiring writers?

    I’m planning to start my own site soon but I’m a little lost on everything.

    Would you propose starting with a free platform like WordPress or go for a paid option? There are
    so many choices out there that I’m completely confused ..
    Any suggestions? Appreciate it! asmr https://app.gumroad.com/asmr2021/p/best-asmr-online asmr

    Reply

  27. Hi, I do think this is an excellent website. I
    stumbledupon it 😉 I will revisit once again since i have saved
    as a favorite it. Money and freedom is the greatest way to change, may you be rich and continue to help
    others. quest bars http://bit.ly/3C2tkMR quest bars

    Reply

  28. Nice post. I learn something new and challenging on websites I stumbleupon on a
    daily basis. It’s always exciting to read through content from other
    writers and practice a little something from their web sites.

    cheap flights http://1704milesapart.tumblr.com/ cheap flights

    Reply

  29. Howdy would you mind stating which blog platform you’re working with?
    I’m planning to start my own blog in the near future but
    I’m having a difficult time making a decision between BlogEngine/Wordpress/B2evolution and Drupal.
    The reason I ask is because your layout seems different then most blogs and I’m looking for something unique.

    P.S Apologies for getting off-topic but I had to ask!
    scoliosis surgery https://0401mm.tumblr.com/ scoliosis surgery

    Reply

  30. Hi there to every one, the contents existing at this web page are genuinely awesome for people experience, well, keep up the nice
    work fellows. quest bars https://www.iherb.com/search?kw=quest%20bars quest bars

    Reply

  31. cost of ivermectin lotion how much does ivermectin cost – ivermectin 50

    Reply

  32. I am really happy to glance at this web site posts
    which includes lots of useful information, thanks for
    providing these statistics. scoliosis surgery https://coub.com/stories/962966-scoliosis-surgery scoliosis surgery

    Reply

  33. medication for ed natural ed treatment – diabetes and ed

    Reply

  34. injectable ed drugs the best ed pill – cheap medications

    Reply

Leave a reply

Your email address will not be published. Required fields are marked *