[gnome-games] hacking: Add 'Coding Message Guidelines' section
- From: Adrien Plazas <aplazas src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-games] hacking: Add 'Coding Message Guidelines' section
- Date: Tue, 12 Jul 2016 07:22:10 +0000 (UTC)
commit cc81b492f1027cf3f2d5634d75b22ea7a786a51a
Author: Adrien Plazas <kekun plazas laposte net>
Date: Tue Jul 12 09:17:41 2016 +0200
hacking: Add 'Coding Message Guidelines' section
HACKING | 34 ++++++++++++++++++++++++++++++++++
1 files changed, 34 insertions(+), 0 deletions(-)
---
diff --git a/HACKING b/HACKING
index adccb11..c066e22 100644
--- a/HACKING
+++ b/HACKING
@@ -2,3 +2,37 @@ Coding Style Guidelines
=======================
Read CodingStyle.txt
+
+Commit Message Guidelines
+=========================
+
+Follow GNOME's commit message guidelines:
+ https://wiki.gnome.org/Git/CommitMessages
+
+To these rules we add some others.
+
+General rules:
+- in the description, try to fill as much as possible your lines (don't
+ go to the line if the next word can fit),
+- don't go to the line after a sentence except of course if you cant add
+ words after,
+- split paragraphs with two newlines (one empty line),
+- if the context isn't sufficient, be explicit with the types and the
+ namespaces of the codepoints you cite,
+- suffix methods and functions with parentheses (without the space) so
+ when reading we know the name refers to an operation,
+- write property names between single quotes and in kebab-case.
+
+The actual changes:
+- the first paragraph explains what the commit does from an objective
+ point of view: the code change,
+- if the shortlog is explicit enough, this first paragraph can be
+ omitted,
+- try to start sentences by the action performed, try to use the
+ infinitive.
+
+The reasoning behind the changes:
+- the second paragraph explains what the commit does from a subjective
+ point of view: the behavior change,
+- don't write about what was before this commit, write about what this
+ commit does.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]