hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Steve Loughran (JIRA)" <j...@apache.org>
Subject [jira] [Created] (HADOOP-12143) Add a style guide to the Hadoop documentation
Date Mon, 29 Jun 2015 08:21:05 GMT
Steve Loughran created HADOOP-12143:
---------------------------------------

             Summary: Add a style guide to the Hadoop documentation
                 Key: HADOOP-12143
                 URL: https://issues.apache.org/jira/browse/HADOOP-12143
             Project: Hadoop Common
          Issue Type: Improvement
          Components: documentation
    Affects Versions: 2.7.0
            Reporter: Steve Loughran
            Assignee: Steve Loughran


We don't have a documented style guide for the Hadoop source or its tests other than "use
the Java rules with two spaces". 

That doesn't cover policy like
# exception handling
# logging
# metrics
# what makes a good test
# why features that have O(n) or worse complexity or extra memory load on the NN & RM
Are "unwelcome",
# ... etc

We have those in our heads, and we reject patches for not following them —but as they aren't
written down, how can we expect new submitters to follow them, or back up our vetos with a
policy to point at.

I propose having an up to date style guide which defines the best practises we expect for
new codes. That can be stricter than the existing codebase: we want things to improve.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message