Return-Path: X-Original-To: apmail-hadoop-common-issues-archive@minotaur.apache.org Delivered-To: apmail-hadoop-common-issues-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id F2A91184C9 for ; Mon, 29 Jun 2015 08:21:06 +0000 (UTC) Received: (qmail 27879 invoked by uid 500); 29 Jun 2015 08:21:05 -0000 Delivered-To: apmail-hadoop-common-issues-archive@hadoop.apache.org Received: (qmail 27817 invoked by uid 500); 29 Jun 2015 08:21:05 -0000 Mailing-List: contact common-issues-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: common-issues@hadoop.apache.org Delivered-To: mailing list common-issues@hadoop.apache.org Received: (qmail 27565 invoked by uid 99); 29 Jun 2015 08:21:05 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 29 Jun 2015 08:21:05 +0000 Date: Mon, 29 Jun 2015 08:21:05 +0000 (UTC) From: "Steve Loughran (JIRA)" To: common-issues@hadoop.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Created] (HADOOP-12143) Add a style guide to the Hadoop documentation MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 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 o= ther than "use the Java rules with two spaces".=20 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 t= he NN & RM Are "unwelcome", # ... etc We have those in our heads, and we reject patches for not following them = =E2=80=94but 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)