From 165652a197bff5ae14435eb88e70c719d3d22a3d Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Mon, 6 Jun 2011 18:54:10 +0100 Subject: [PATCH] CG: another GOP suggestion. --- Documentation/contributor/administration.itexi | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/Documentation/contributor/administration.itexi b/Documentation/contributor/administration.itexi index 980c2141fe..9f25b72459 100644 --- a/Documentation/contributor/administration.itexi +++ b/Documentation/contributor/administration.itexi @@ -507,6 +507,23 @@ possibly including regtests for currently-broken functionality. (prep: 2 hours. discuss: 5 hours) +@item @strong{code readability}: +"Our aim when producing source code for Lilypond in whatever +language is that it should be totally comprehensible to a +relatively inexperienced developer at the second reading." + +Rationale: +- aids maintainability of code base +- "second reading" so newer developers can look up unfamiliar + stuff +- will help to keep things simple, even if the code is doing + complex stuff discourages "secret squirrel" coding, e.g. "how + much functionality can I squeeze into as few characters as + possible" "comments are for wimps" +- will aid not *discouraging* new developers to join the project + +(prep: 2 hours. discuss: 10 hours) + @end itemize -- 2.39.5