• TehPers ( TehPers@beehaw.org ) 
      link
      fedilink
      English
      arrow-up
      1
      ·
      9 hours ago

      In your PR:

      ## Release notes
      
      - Fixed foo returning baz instead of bar when qux is passed in
      

      Your commit messages are pretty useless to the people actually reading the changelogs. If you need automatic changelog generation, then stitch it from parts written for humans to read.

    • atzanteol ( atzanteol@sh.itjust.works ) 
      link
      fedilink
      English
      arrow-up
      4
      ·
      2 days ago

      You don’t. Users are different audience than the development team. Messages intended for one group are different from those for the other. This is my biggest gripe about this “semantic” BS. Commit comments are for the dev team. You should summarize it in a way that makes sense to users.

      Every time I see a “changelog” from a team for something I use that is full of “fix: loop pointer in Foo.java” I just roll my eyes. Like that tells me anything useful. If I cam technically savvy enough and care I can go look at the git history. But as a user that’s meaningless.