commit-rules.txt 865 Bytes
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
Commit Rules
============

This file describes rules and things to think about when creating GIMP
commits.

 * Commit message format template:

     modulename: Summary on one line

     Detailed description that may span several paragraphs and
     lines. Like this example description that is more than one
13
     line. Focus on explaining _why_ the commit is needed.
14 15 16 17 18 19 20

   or

     Bug XXXXXX - Bug title

     Detailed description that may span several paragraphs and
     lines. Like this example description that is more than one
21
     line. Focus on explaining _why_ the commit is needed.
22 23 24 25 26 27 28

   Look at existing commit messages for examples.

 * Keep NEWS up to date

   Whenever you make a change that is worthy of being mentioned in the
   NEWS file, update the NEWS file too. The purpose of this rule is to
29
   make it as easy as possible to make a GIMP release.