[Pkg-pascal-devel] commit documentation proposal

[Abou Al Montacir]

On Fri, 2014-03-21 at 14:08 +0100, Paul Gevers wrote:
> Hi all,
> 
> While considering some of my last e-mails to this list, I came up with
> the following proposal.
> 
> When someone makes a commit in one of our packages let us not only write
> down what we do in the commit, but also spend a line on WHY we make the
> change (in the way we do it). Trivial things (like fixing obvious
> mistakes) don't need it of course, but let's try to not be too sparse
> otherwise, especially if there were (multiple) alternatives.
> 
> Paul

Hi,

Generally I like be verbose in commit. We can use the following syntax:

----- start of message, this line excluded -----
Short description of the commit

Long description of the commit
----- End of message, this line excluded -----

Most graphical tools will ignore comments after the black line in the
tree view. Then on detail commit view you have the full reason and
details.

Cheers,
Abou Al Montacir,
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 230 bytes
Desc: This is a digitally signed message part
URL: <http://lists.alioth.debian.org/pipermail/pkg-pascal-devel/attachments/20140327/ee26bfc8/attachment.sig>