diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..6ac0df79 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +# Top-most EditorConfig file +root = true + +[*] +end_of_line = lf +insert_final_newline = true +indent_style = tab +charset = utf-8 diff --git a/docs/dev/basics.rst b/docs/dev/basics.rst index 18aec227..0f53d6d4 100644 --- a/docs/dev/basics.rst +++ b/docs/dev/basics.rst @@ -67,5 +67,10 @@ apply: - use tabs instead of spaces - trailing whitespaces must be eliminated +- files need to end with a final newline +- newlines need to have unix line endings (lf) + +To that end we provide a ``.editorconfig`` configuration, which is supported by most +of the editors out there. If you add Lua scripts to gluon, check formatting with ``luacheck``.