[ 
https://issues.apache.org/jira/browse/HADOOP-12145?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14608016#comment-14608016
 ] 

Steve Loughran commented on HADOOP-12145:
-----------------------------------------

Ray, this is really good.

By sheer coincidece, HADOOP-12143 has proposed adding a style guide to 
ultimately check in to the docs.

Your checklist adds items that should be in the style guide too (e.g 
compatibility statements, config options & deprecation, how public APIs have to 
be changed, ...

Could we combine these somehow? I could imagine having a bit in the site on 
{{coding/}} where we have this checklist and the style guide alongside each 
other. And, being under SCM, we implicitly address the "no change without 
permission" policy, as well as the usual change history, patch-to-update mode, 
etc.




> Organize and update CodeReviewChecklist wiki
> --------------------------------------------
>
>                 Key: HADOOP-12145
>                 URL: https://issues.apache.org/jira/browse/HADOOP-12145
>             Project: Hadoop Common
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Ray Chiang
>            Assignee: Ray Chiang
>            Priority: Minor
>         Attachments: 2015_CodeReviewChecklistWiki.001.pdf
>
>
> I haven't done too many reviews yet, but I've definitely had a lot of good 
> review from others in the community.
> I've put together a preliminary update with the following things in mind:
> - In the spirit of trying to lower the barrier for new developers, 
> reorganized the document to be a bit more like a checklist
> - Added checklist items that other reviewers have caught in my earlier patch 
> submissions
> - Added more checklist items based on what I've read in past JIRAs



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

Reply via email to