From aea709de31af52ef8d29137e8700344f21bd589a Mon Sep 17 00:00:00 2001 From: Andreas Kling Date: Fri, 14 May 2021 16:45:27 +0200 Subject: [PATCH] Meta: Add note about writing commit subjects in the imperative mood --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a33de83ca6..8164d68f734 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,8 @@ Nobody is perfect, and sometimes we mess things up. That said, here are some goo * Split your changes into separate, atomic commits. * Make sure your commits are rebased on the master branch. * Wrap your commit messages at 72 characters. -* The first line of the commit message should have the format "Category: Brief description of what's being changed". The "category" can be a subdirectory, but also something like "POSIX compliance" or "ClassName". Whatever seems logical. +* The first line of the commit message is the subject line, and should have the format "Category: Brief description of what's being changed". The "category" can be a subdirectory, but also something like "POSIX compliance" or "ClassName". Whatever seems logical. +* Write the commit message subject line in the imperative mood ("Foo: Change the way dates work", not "Foo: Changed the way dates work") * Write your commit messages in proper English, with care and punctuation. * Squash your commits when making revisions after a patch review. * Add your personal copyright line to files when making substantive changes. (Optional but encouraged!)