From 28a4fd80ffd8604ef82bba2ab6fd8d53c1f4887a Mon Sep 17 00:00:00 2001 From: Patrick Vogler Date: Tue, 20 Jun 2023 14:32:35 +0000 Subject: [PATCH] Update 'Coding Style' --- Coding-Style.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/Coding-Style.md b/Coding-Style.md index 736adff..fa84503 100644 --- a/Coding-Style.md +++ b/Coding-Style.md @@ -26,4 +26,12 @@ This document discusses practices and style for programmers working on the BigWh - [Syntactic Conventions](#syntactic_conventions) - [Names](#names) -## The Single Most Important Rule \ No newline at end of file +## The Single Most Important Rule +Above all, the following rule from the GNOME developer documentation should always be followed. +>The single most important rule when writing code is this: check the surrounding code and try to imitate it. +> +>As a maintainer it is dismaying to receive a patch that is obviously in a different coding style to the surrounding code. This is >disrespectful, like someone tromping into a spotlessly-clean house with muddy shoes. +> +>So, whatever this document recommends, if there is already written code and you are contributing to it, keep its current style >consistent even if it is not your favorite style. +> +>Most importantly, do not make your first contribution to a project a change in the coding style to suit your taste. That is >incredibly disrespectful. \ No newline at end of file