[
https://issues.apache.org/jira/browse/HADOOP-12143?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Andras Bokor updated HADOOP-12143:
----------------------------------
Description:
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.
was:
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.
> 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.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
