From efde11161599deb6d98fb5773c3225d589bb14c2 Mon Sep 17 00:00:00 2001 From: Tobin Harding Date: Fri, 10 Dec 2021 11:49:20 +1100 Subject: [PATCH] Use the imperative mood in example subject line The section `Committing Patches` contains an example commit subject line that violates rule seven of the linked guide to writing commit logs (Chris Beams famous blog post). We should practice what we preach, especially in examples :) Use the imperative mood in example commit message subject line. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index acf5cc08d17..59f662ad341 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -119,7 +119,7 @@ own without warnings, errors, regressions, or test failures. Commit messages should be verbose by default consisting of a short subject line (50 chars max), a blank line and detailed explanatory text as separate -paragraph(s), unless the title alone is self-explanatory (like "Corrected typo +paragraph(s), unless the title alone is self-explanatory (like "Correct typo in init.cpp") in which case a single title line is sufficient. Commit messages should be helpful to people reading your code in the future, so explain the reasoning for your decisions. Further explanation [here](https://chris.beams.io/posts/git-commit/).