From eba946bf99d5359bb4fef54e36abbd5ee31a5371 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Thu, 27 Jan 2022 18:22:07 +0000 Subject: [PATCH 1/2] Add .editorconfig to enforce some standards --- .editorconfig | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..977ec02 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,21 @@ +# This is the project top-level .editorconfig +root = true + +# Defaults for all file types +[*] +# 4-space indents, no TABs +indent_style = space +tab_width = 4 +indent_size = tab + +# Hard-wrap at 120 columns +max_line_length = 119 + +# Unix EOL, single \n +end_of_line = lf + +# UTF-8 is the only sensible option, no BOM +charset = utf-8 + +# All files should have a final newline +insert_final_newline = true From 8ac2ac8ac603c315d69d65e7fbf7b822d120bf33 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Thu, 27 Jan 2022 18:23:28 +0000 Subject: [PATCH 2/2] Start a docs/Contributing.md * Call out the .editorconfig file --- docs/Contributing.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docs/Contributing.md diff --git a/docs/Contributing.md b/docs/Contributing.md new file mode 100644 index 0000000..1eaadd3 --- /dev/null +++ b/docs/Contributing.md @@ -0,0 +1,13 @@ +# Contributing to the EDDN Project + +## Introduction + +This file is still mostly a stub. + +## Text format + +The project contains an `.editorconfig` file at its root. Please either ensure +your editor is taking note of those settings, or cross-check its contents +with the +[editorconfig documentation](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties) +, and ensure your editor/IDE's settings match.