[Aside] Generating commit messages for Org

[Aside] Generating commit messages for Org

[Timothy]

[-- Attachment #1.1: Type: text/plain, Size: 1267 bytes --]

Hi All,

A few hours ago I noticed that I’ve made a few very minor mistakes in some of my
recent commit messages for Org. Realistically I don’t think I’m going to stop
making occasional mistake any time soon, eve if they do become rarer. So, I’ve
whipped up a magit hook that looks at the diff and fills in a /correct/ skeleton
in the commit message buffer.

For example, here’s what I get if a queue a few of my currently unstaged changes
┌────
│ * lisp/org.el (org-place-formula-image, org-format-latex):
│ 
│ * lisp/org-macs.el (org-compile-file, org-async-queue):
└────

This currently works with elisp functions/variables/etc. and headings from
documentation files. I’m sure it has a few rough edges, but it’s looking
promising so far.

Maybe a few of you might also find it of interest?
<https://tecosaur.github.io/emacs-config/config.html#commit-message-templates>
(the relevant commit is <https://github.com/tecosaur/emacs-config/commit/d1e3042a>).

Another thought I’ve had is a commit lint function for flycheck to check some
extra things (two spaces after sentences, commit subject starting with a capital
letter, etc.), but I haven’t looked into that at all.

All the best,
Timothy

[-- Attachment #1.2: Type: text/html, Size: 4443 bytes --]

Re: [Aside] Generating commit messages for Org

[Robert Pluim]

>>>>> On Sun, 21 Nov 2021 04:27:45 +0800, Timothy <tecosaur@gmail.com> said:

    Timothy> Hi All,
    Timothy> A few hours ago I noticed that I’ve made a few very minor mistakes in some of my
    Timothy> recent commit messages for Org. Realistically I don’t think I’m going to stop
    Timothy> making occasional mistake any time soon, eve if they do become rarer. So, I’ve
    Timothy> whipped up a magit hook that looks at the diff and fills in a /correct/ skeleton
    Timothy> in the commit message buffer.

    Timothy> For example, here’s what I get if a queue a few of my currently unstaged changes
    Timothy> ┌────
    Timothy> │ * lisp/org.el (org-place-formula-image, org-format-latex):
    Timothy> │ 
    Timothy> │ * lisp/org-macs.el (org-compile-file, org-async-queue):
    Timothy> └────

    Timothy> This currently works with elisp functions/variables/etc. and headings from
    Timothy> documentation files. I’m sure it has a few rough edges, but it’s looking
    Timothy> promising so far.

I suggest you look at `add-change-log-entry-other-window' and/or
`magit-generate-changelog'.

Robert
-- 

Re: [Aside] Generating commit messages for Org

[Timothy]

[-- Attachment #1: Type: text/plain, Size: 331 bytes --]

Hi Robert,

> I suggest you look at `add-change-log-entry-other-window’ and/or
> `magit-generate-changelog’.

Thanks for the suggestions. I happen to have already had a peek, but thought it
would be easier to make something from scratch than integrate those to create
the experience I wanted.

All the best,
Timothy