]> git.donarmstrong.com Git - lilypond.git/commitdiff
CG: another GOP suggestion.
authorGraham Percival <graham@percival-music.ca>
Mon, 6 Jun 2011 17:54:10 +0000 (18:54 +0100)
committerGraham Percival <graham@percival-music.ca>
Mon, 6 Jun 2011 17:54:10 +0000 (18:54 +0100)
Documentation/contributor/administration.itexi

index 980c2141fe794661720570f91c17ef9df5373359..9f25b7245917ac8f69a1bbd35d0ac030321aad72 100644 (file)
@@ -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