From 2a0f3c873c39a8cf7eb3614464904de171fa3762 Mon Sep 17 00:00:00 2001 From: Daniel Xu Date: Thu, 30 Jul 2020 18:03:34 -0700 Subject: [PATCH] btrfs-progs: Update README.md with editorconfig hint Add a helpful hint in the README to encourage contributors to install an editorconfig plugin. This should help maintain source file consistency in the long term (eg tabs instead of spaces). Reviewed-by: Neal Gompa Signed-off-by: Daniel Xu [ update coding style references, reword ] Signed-off-by: David Sterba --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 537c77c5..5d8e9b55 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,12 @@ the patches meet some criteria (often lacking in github contributions): substitute in order to allow contributions without much bothering with formalities +Source code coding style and preferences follow the +[kernel coding style](https://www.kernel.org/doc/html/latest/process/coding-style.html). +You can find the editor settins in `.editorconfig` and use the +[EditorConfig](https://editorconfig.org/) plugin to let your editor use that, +or update your editor settings manually. + Documentation updates ---------------------