[ 
https://issues.apache.org/jira/browse/HBASE-2607?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12870645#action_12870645
 ] 

stack commented on HBASE-2607:
------------------------------

I just reviewed the page.   Here's some stuff you might look into:

+ Jon has started adding the label 'noob' to issues that might be good for new 
devs.  You might want to make mention of this fact in here (We should all take 
up this practise of Jon's).
+ Maybe start off the coding ocnvention section w/ a general note that the new 
dev should not break with the convention they see in files being modified
+ Tests should be written using junit4 (It says junit only.. qualifiy w/ junit 
4 to be clear)
+ These classes are now deprecated "You must implement a class that extends 
junit.framework.TestCase, org.apache.hadoop.hbase.HBaseTestCase or 
org.apache.hadoop.hbase.HBaseClusterTestCase and whose class name starts with 
Test."  In junit4 no need to subclass a TestCase.  Instead new devs should be 
using HBaseTestingUtility.  Perhaps point them at something like 
TestingFromClientSide as example for how to use this utility.
+ They need to name the clase with a 'Test' prefix so it'll be notice by the 
mvn test runner.  Point at a unit test example because as this is written 
'Define methods within your class whose names begin with test, and call JUnit's 
many assert methods to verify conditions; these methods will be executed when 
you run mvn install.', it would seem to presume junit3 (in junit4 you use 
annotations but yes, even here tests should be name testOne, testTwo, etc)
+ Regards this, "By default, do not let tests write any temporary files to 
/tmp. Instead, the tests should write to the location specified by the 
test.build.data system property.", tell user to look at HBaseTestingUtility.  
It has defines for test dir setup.
+ This is incorrect. "If a HBase cluster is needed by your test, either 
subclass org.apache.hadoop.hbase.HBaseClusterTestCase or use 
org.apache.hadoop.hbase.MiniHBaseCluster. If you also need to use a MapReduce 
cluster, use org.apache.hadoop.mapred.MiniMRCluster."  Again see HTU.
+ You can do 'mvn test' in maven to just run tests.  Or 'mvn test 
-Dtest=CLASSNAME'   Point to the mvn wiki page I'd say.
+ Does this need a '-p' on it --> "git diff"?
+ Have patchnames end in 'txt' rather than 'patch' so we can open patch easy in 
browser.
+Says "Hadoop source" instead of "hbase source"
+ You might want to check out the hadoop page on same subject.  This page was 
taken from thre originally and they may have deviated... might be good stuff 
over on the hadoop page.

Thanks for doing this D.

> Update HowToContribute wiki page
> --------------------------------
>
>                 Key: HBASE-2607
>                 URL: https://issues.apache.org/jira/browse/HBASE-2607
>             Project: Hadoop HBase
>          Issue Type: Task
>            Reporter: Daniel Ploeg
>            Assignee: Daniel Ploeg
>             Fix For: 0.21.0
>
>
> The Hbase wiki is currently out of date. I would like to see it updated so 
> that new / current developers can have a single source describing the current 
> process.
> From the hbase dev email list:
> Some issues that I see / things that I would like clarified include:
> 1. The use of ant - from what I understand this is no longer the case as 
> maven has been introduced. As a result a number of the instructions are out 
> of date.
> 2. Use of git - from what I gathered from trawling the hbase-dev list, a git 
> repo is available. I'd prefer to use this approach as I think it is a better 
> way to work (probably a number of you agree). I'd like to see a reference to 
> the git repo here and perhaps some instructions on how to work with git in 
> the hbase context (might help others in the future adopt git rather than svn).
> 3. The recent introduction of the use of Review Board for reviewing work. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to