btrfs-progs: Update README.md with editorconfig hint
diff mbox series

Message ID 20200731010334.47406-1-dxu@dxuuu.xyz
State New
Headers show
Series
  • btrfs-progs: Update README.md with editorconfig hint
Related show

Commit Message

Daniel Xu July 31, 2020, 1:03 a.m. UTC
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).

Signed-off-by: Daniel Xu <dxu@dxuuu.xyz>
---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Neal Gompa July 31, 2020, 3:40 a.m. UTC | #1
On Thu, Jul 30, 2020 at 9:05 PM Daniel Xu <dxu@dxuuu.xyz> wrote:
>
> 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).
>
> Signed-off-by: Daniel Xu <dxu@dxuuu.xyz>
> ---
>  README.md | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/README.md b/README.md
> index 537c77c5..2d5f360f 100644
> --- a/README.md
> +++ b/README.md
> @@ -82,6 +82,10 @@ the patches meet some criteria (often lacking in github contributions):
>      substitute in order to allow contributions without much bothering with
>      formalities
>
> +btrfs-progs is configured with an `.editorconfig`. Please consider installing an
> +[EditorConfig](https://editorconfig.org/) plugin for your text editor to help
> +maintain source file format consistency.
> +
>  Documentation updates
>  ---------------------
>
> --
> 2.27.0
>

LGTM.

Reviewed-by: Neal Gompa <ngompa13@gmail.com>
David Sterba July 31, 2020, 1:47 p.m. UTC | #2
On Thu, Jul 30, 2020 at 06:03:34PM -0700, Daniel Xu wrote:
> 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).
> 
> Signed-off-by: Daniel Xu <dxu@dxuuu.xyz>

Thanks, I've added references to the coding style and reworded the
paragraph a bit.

Patch
diff mbox series

diff --git a/README.md b/README.md
index 537c77c5..2d5f360f 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,10 @@  the patches meet some criteria (often lacking in github contributions):
     substitute in order to allow contributions without much bothering with
     formalities
 
+btrfs-progs is configured with an `.editorconfig`. Please consider installing an
+[EditorConfig](https://editorconfig.org/) plugin for your text editor to help
+maintain source file format consistency.
+
 Documentation updates
 ---------------------