• Solivine@sopuli.xyz
    link
    fedilink
    arrow-up
    3
    arrow-down
    6
    ·
    edit-2
    11 months ago

    When there’s a limit to the size of a commit message it does make it difficult to actually list all the changes, so sometimes this is all you can write.

    I know in theory you’re meant to commit little and often, but in practice it doesn’t always work out that way.

    • PuzzledBlueberry@lemmy.world
      link
      fedilink
      arrow-up
      11
      arrow-down
      1
      ·
      11 months ago

      Even if you have a big commit, you can always write something more descriptive than this. And commit messages can be huge, so the limit shouldn’t be an excuse to write a useless message.

      • Ekky@sopuli.xyz
        link
        fedilink
        arrow-up
        9
        ·
        11 months ago

        For those wondering how to exceed the 70 (80) recommended character limit and still follow best practices:

        1. Write the title on the first line, keep below 70 characters.
        2. Make two (2) newlines
        3. Write one or more descriptive paragraphs.

        The first line will be shown as commit message, and the full text can usually be viewed by checking out the commit. Sentences can span multiple lines, but try to keep the line length below 70 characters for best readability.

        This off the top of my head, so feel free to correct me if I’ve misremembered the best practices.

        • r00ty@kbin.life
          link
          fedilink
          arrow-up
          4
          ·
          11 months ago

          I generally write a single line summary and then a list of the specifics like:

          Did stuff (except more detailed than that)
           - The first thing I did
            - Maybe some more detail about the first thing because there's a rationale to explain
           - The second thing I did
           - Third thing
          
          

          Etc.