Merge pull request jgonggrijp#110 from realshouzy/add-line-length-gui…

…deline Configs And Docs: Add ``.editorconfig`` and update guidelines in ``CONTRIBUTING.md``
realshouzy · Aug 30, 2023 · 6f9779c · 6f9779c
2 parents 659da2c + 472e40c
commit 6f9779c
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,13 @@
+# https://editorconfig.org/
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+indent_size = 4
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,4 +16,6 @@ Any kind of contribution is welcome; nothing is "off limits". However, for those
 
 This repo ([jgonggrijp/pip-review](https://github.com/jgonggrijp/pip-review)) uses [gitflow](https://github.com/nvie/gitflow). Please submit pull requests to the `develop` branch.
 
-The Python files use 4-space soft tabs. The other files use 2-space soft tabs.
+To maintain consistent coding style and formatting across the project, an [``EditorConfig`` file](/.editorconfig) has been set up, in order to guarantee that all contributors use the same settings for indentation, character encoding, line endings etc.
+
+Additionally, please ensure that lines of code do not exceed a **maximum length of 79 characters** to further enhance readability and consistency of the project.