From 40c2e3f442d8fc28eca94ab11a429f11d6da3fe5 Mon Sep 17 00:00:00 2001 From: KernelDeimos Date: Mon, 1 Apr 2024 19:33:11 -0400 Subject: [PATCH] Add April-1st-appropriate commit message guidelines --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb6c1073..b28814b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,6 +57,28 @@ See [doc/contributors/index.md](./doc/contributors/index.md) for more informatio
+## Commit Messages + +Use the imperative, as is the convention in the Linux kernel: + +- correct: `Improve performance of readdir` +- incorrect: `Improved readdir` +- incorrect: `Improving readdir` + +We have the following exceptions to this rule: +- If the commit message is in _past tense_, it's a shorthand for the following: + - `Apply changes that would be applied after one had ` +- If the commit message is in _present tense_, it's shorthand for the following: + - `Apply changes that would be applied after ` + +For example, the following are correct: +- `Improved readdir` + - interpret this as: `Apply changes that would be applied after one had improved readdir` +- `Improving readdir` + - interpret this as: `Apply changes that would be applied after improving readdir` + +
+ ## Code Review Once you've submitted your pull request, the project maintainers will review your changes. We may suggest some changes or improvements. This is a normal part of the process, and your contributions are greatly appreciated!