[
https://issues.apache.org/jira/browse/HADOOP-12145?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14608696#comment-14608696
]
Ray Chiang commented on HADOOP-12145:
-------------------------------------
I'm 100% in agreement (combining documentation, creating a specific style
guide, providing illustrative code examples, SCM for this documentation, etc.).
There are a few things I can think of that are missing (or maybe in a document
that I've missed):
- File naming and location (at least for the basics)
- JIRA subject phrasing (make the subject actionable and specific)
- Good Practices w.r.t tools (more for Java newbies, not just Hadoop newbies)
I've read up on the proposed coding style document some and it looks good so
far. I'll comment on the JIRA as I read further.
In the meantime, should I close this JIRA as a duplicate, move it as a subtask,
or something else?
> 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)
