aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2019-07-07 17:47:49 +0100
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2019-07-07 17:51:46 +0100
commit1643e10563fa8d68f1643fbc4e6df3ecfac57449 (patch)
tree5159898a88e8a31e5ff3d67a9c8172ded93b57f5
parentd2887a9239992fb8e62b0506000b0a8e7d48aaca (diff)
Commit message format tip added to README-hacking.md
Until now there was no guideline in `README-hacking.md' to describe/suggest a good format for commit messages. With this commit a point has been added in the "Tips" section to help new developers contribute more smoothly. The necessity of this paragraph was pointed out by Mohammad-reza Khellat.
-rw-r--r--.file-metadatabin6236 -> 6157 bytes
-rw-r--r--README-hacking.md16
2 files changed, 16 insertions, 0 deletions
diff --git a/.file-metadata b/.file-metadata
index 9956492..46a481f 100644
--- a/.file-metadata
+++ b/.file-metadata
Binary files differ
diff --git a/README-hacking.md b/README-hacking.md
index a02fe87..12b408a 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -906,6 +906,22 @@ for the benefit of others.
regularly (after any meaningful change/step/result), while not
forgetting the following notes.
+ - *Commit message*: The commit message is a very important and useful
+ aspect of version control. To make the commit message useful, it
+ would be good if you follow the following convensions. You can see
+ many examples by running `git log` in the `template` branch. If you
+ intend to improve the template by forking it and pushing commits, it
+ is mandatory to follow these guidelines. 1) No line should be more
+ than 75 characters (to enable easy reading of the message when you
+ run `git log`). 2) The first line is the title of the commit and
+ should summarize it (so `git log --oneline` can be useful). The title
+ should also not end with a point (`.`). 3) After the title leave an
+ empty line and start the body of your message (possibly containing
+ many paragraphs). 4) Describe the context of your commit (the problem
+ it is trying to solve) as much as possible before going onto how you
+ solved it. One useful suggestion is to always start the main body of
+ your commit with "Until now".
+
- *Tags*: To help manage the history, tag all major commits. This helps
make a more human-friendly output of `git describe`: for example
`v1-4-gaafdb04` states that we are on commit `aafdb04` which is 4