Re: contrib/README

[Carsten Dominik <carsten.dominik@gmail.com>]

On Jul 1, 2010, at 2:15 PM, Stephen Eglen wrote:

>
>> Please that we no longer use ChangeLog, but that we place entries
>> with similar syntax into the commit message and then later
>> build ChangeLog from that.
>>
>> If you look at the final commit, you'll see what I mean.
>
> I see - neat idea about the ChangeLog.  Can you still use 'C-x 4 a'  
> from
> a buffer to help build the ChangeLog entries though which ultimately  
> go
> in the commit messages?  What's the workflow (sorry if this has been
> discussed before)?

The workflow is to use magit, and the to press `C' at a snippet in the
magit status buffer.  This is equivalent to `C-x 4 a'.

Please make sure that

- the commit message still has a single first line, followed by a  
newline
- after the newline, the ChangeLog entry should be placed, first line  
starting
   with a star, and no empty lines inside the block.
- After the ChangeLog block, and another empty line, you can add any  
free-form
   explanations you want - they will be discarded when building the  
ChangeLog file.

See also

http://orgmode.org/worg/org-contribute.php#sec-4

HTH

- Carsten