• Kissaki@programming.dev
    link
    fedilink
    English
    arrow-up
    2
    ·
    19 hours ago

    I want to be able to scan a commit log, not just read commit titles one by one.

    The type gives me a scoping of to be expected intention, change size, and potential for side effects. docs never have runtime side effects.

    The scope gives me categories to scan for. Which area of the project am I searching for? Which product feature? If there’s a user bug, I can check those in the specific area and more general ones first.

    I need scope to be small, so the visual scanability is not broken because of horizontal shifting of the actual commit change title.

    I made sure my team capitalizes the commit change title, as an additional visual queue for scanability; being able to blend out the prefix.

    Even if you don’t care about changelog generating or log scanability for developers searching, debugging, or analyzing, I find deliberate commit messages practice helpful in guiding both in thought and documenting though of what the intention of the commit is, whether to split changes because they’re logically unrelated/not the same step, etc.

    In a small project or freshly started project before going stable or sizable it may not be necessary, but I still enjoy following the general practice.

    (cut off because it’s a customer project, just to be sure)

    No prefixes is a lot less useful. Commits can provide structure and guidance.

    Personally, I don’t like chore though, and we don’t use it in our project, reducing the number of types. Typically, those are misc(proj) or misc(ci) instead.

    The customer receives a list of feat and fix commit titles as info with a release.

    Commits are already data. Metadata about changes. Merge commits are structured data, putting individual changes into structured context. Using short well defined prefixes/prefix formats is a logical extension.

    • atzanteol@sh.itjust.works
      link
      fedilink
      English
      arrow-up
      1
      ·
      14 hours ago

      The customer receives a list of feat and fix commit titles as info with a release.

      The problem is that the language customers want and the language developers want are different things. Abusing commit messages to try to create documentation is just a bad idea. Spend a few mins to summarize for your users what has changed. You should be able to pull the tickets that went into a release for that pretty easily. Hell have AI do it if you’re that lazy. But as a developer I want to know what your commit did. Just explain your change in a way that will help me later on.