magit, changelogs and commit formatting

magit, changelogs and commit formatting

[Eric Abrahamsen]

I know we're supposed to move to automatically-generated changelogs Real
Soon Now, but in the meantime...

I'm having a bit of confusion about the best way to format git patches
for Emacs packages. I've pushed a few almost-but-not-quite patches that
other people have had to fix afterwards (I'm talking about commit
message formatting), and that's embarrassing. What I've done in the past
is start the commit from Magit, then hit "C" in the patch buffer, which
inserts a fairly intelligent log template into the commit message
buffer, and then I work with that.

But of course the ChangeLog is supposed to be part of the commit, which
means these messages have to be created before I even get to the commit
buffer, which so far has meant a lot of manually adding function names
and parentheses and making sure there are two spaces between the date
and my name/address.

Is there a different magic function I'm missing? Can some greybeard
quickly share a workflow? How does everyone else do this?

Any hints appreciated,

Eric

Re: magit, changelogs and commit formatting

[Dmitry Gutov]

Hi Eric,

On 09/11/2015 06:38 PM, Eric Abrahamsen wrote:
> I know we're supposed to move to automatically-generated changelogs Real
> Soon Now, but in the meantime...

We've transitioned to it already.

> I'm having a bit of confusion about the best way to format git patches
> for Emacs packages.

Not sure about third-party packages, but for patches for Emacs, see 
CONTRIBUTE.

Re: magit, changelogs and commit formatting

[Eric Abrahamsen]

Dmitry Gutov <dgutov@yandex.ru> writes:

> Hi Eric,
>
> On 09/11/2015 06:38 PM, Eric Abrahamsen wrote:
>> I know we're supposed to move to automatically-generated changelogs Real
>> Soon Now, but in the meantime...
>
> We've transitioned to it already.

I thought I was paying attention! Sorry.

>> I'm having a bit of confusion about the best way to format git patches
>> for Emacs packages.
>
> Not sure about third-party packages, but for patches for Emacs, see
> CONTRIBUTE.

That clears up most of my questions, thank you.

I'd still be interested in seeing actual workflows, from whoever was
willing to share. I contribute occasionally to Gnus, Org and BBDB, and
each package seems to have its own particular relationship with the
general Emacs codebase.

But generally speaking, that answers the question. Thanks!

Eric

Re: magit, changelogs and commit formatting

[Stefan Monnier]

> We've transitioned to it already.
                           ^^^^^^^

That's one way to put it ;-)


        Stefan