isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-23 00:20:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update the HACKING file

Browse Source
This commit is contained in:
Emmanuele Bassi 2011-09-09 12:16:37 +01:00
parent 0d19892cd8
commit 802b9d463c
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/HACKING
View File

@ -64,7 +64,7 @@ tracker reference if applicable) and so forth. Be concise but not too
brief. Don't be afraid of using UTF-8, or even ASCII art. brief. Don't be afraid of using UTF-8, or even ASCII art.
=== end example commit === === end example commit ===
Always add a brief description of the commit to the _first_ line of - Always add a brief description of the commit to the _first_ line of
the commit and terminate by two newlines (it will work without the the commit and terminate by two newlines (it will work without the
second newline, but that is not nice for the interfaces). second newline, but that is not nice for the interfaces).
@ -72,22 +72,24 @@ brief. Don't be afraid of using UTF-8, or even ASCII art.
<newline> - MANDATORY empty line <newline> - MANDATORY empty line
long description - Each line MUST be less than 76 characters long description - Each line MUST be less than 76 characters
Do NOT put the commit message on the short description line. One line - Do NOT put the commit message on the short description line. One line
commit messages should be avoided, unless they can be *fully* explained commit messages should be avoided, unless they can be *fully* explained
in less than 72 characters (e.g. "Fix typo in in less than 72 characters (e.g. "Fix typo in
clutter_actor_create_pango_context() docs"). clutter_actor_create_pango_context() docs").
The brief description might optionally have a "tag", enclosed in - The brief description might optionally have a "tag", i.e. a word or two
square brackets, detailing what part of the repository the commit followed by a color, detailing what part of the repository the commit
affected, e.g.: affected, e.g.:
[alpha] Add :mode property alpha: Add :mode property
[text] Emit ::cursor-event only on changes text: Emit ::cursor-event only on changes
The tag counts as part of overall character count, so try using - The tag counts as part of overall character count, so try using
a short word. Optionally, you can also use the "tag:" form. a short word. Optionally, you can also use the "[tag]" form.
Think of the commit message as an email sent to the maintainers explaining - Build environment fixes should use the "build" tag.
- Think of the commit message as an email sent to the maintainers explaining
"what" you did and, more importantly, "why" you did it. The "how" is not "what" you did and, more importantly, "why" you did it. The "how" is not
important, since "git show" will show the patch inlined with the commit important, since "git show" will show the patch inlined with the commit
message. message.