• DontTakeMySky@lemmy.world
    link
    fedilink
    arrow-up
    8
    ·
    1 year ago

    Don’t just summarize the content though, summarize the rationale or how things connect. I can read your diff myself to see what changed, I want to know the logical connections, the reason you did X and not Y, etc.

    Or just say “stuff” and provide that context in the PR description separately, no need to overdo the commit log on a feature branch if you’re using squash merges from your PR.

    • deadbeef79000@lemmy.nz
      link
      fedilink
      arrow-up
      5
      ·
      edit-2
      1 year ago

      P1000x this.

      I can read a diff.

      I need to know why.

      No, a code comment isn’t good enough, it’s out of date after the next commit.