incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mar...@apache.org
Subject svn commit: r1601795 - /incubator/public/trunk/report_runbook.py
Date Wed, 11 Jun 2014 01:46:29 GMT
Author: marvin
Date: Wed Jun 11 01:46:28 2014
New Revision: 1601795

URL: http://svn.apache.org/r1601795
Log:
Add style guide for podling reports.

Modified:
    incubator/public/trunk/report_runbook.py

Modified: incubator/public/trunk/report_runbook.py
URL: http://svn.apache.org/viewvc/incubator/public/trunk/report_runbook.py?rev=1601795&r1=1601794&r2=1601795&view=diff
==============================================================================
--- incubator/public/trunk/report_runbook.py (original)
+++ incubator/public/trunk/report_runbook.py Wed Jun 11 01:46:28 2014
@@ -84,7 +84,15 @@ def normalize_formatting(options):
         # Normalize the formatting of the podling reports and shepherd
         # reviews.  Remove any blank entries.
         #
-        # TODO: style guide.
+        # The report will ultimately be published as part of the Board
+        # minutes in monospaced plain text.  Here's a style guide:
+        #
+        # * Wrap text at 76 characters.
+        # * Normalize indentation.  For all podling reports, questions are
+        #   flush left, answers indented two spaces.
+        * * No more than one blank line anywhere.
+        # * All URLs which would cause lines to exceed 76 characters
+        #   should be shortened using <http://s.apache.org>.
         ##################################################################
         """)
 



---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org


Mime
View raw message