Changes between Version 8 and Version 9 of MolgenisTicketFaq


Ignore:
Timestamp:
2010-12-01T10:42:34+01:00 (14 years ago)
Author:
Morris Swertz
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • MolgenisTicketFaq

    v8 v9  
    5555}}}
    5656{{{#!td
    57 A todo is a unit of work that does not result in commits to SVN but instead in a wiki page, Excel document, a presentation and so on.
     57A '''todo''' is a unit of work that does not result in commits to SVN but instead in a wiki page, Excel document, a presentation and so on.
    5858So what you need to do is describe this expected output.
    5959
    60 Example ticket:
     60Example ticket: '''Comparison of imputation methods Beagle, Impute and MACH'''
    6161
    6262{{{
     63component: gwas
     64
    6365Why or for whom?
    6466For medgen and bbmri we want to compare imputation methods Beagle, Impute and MACH.
     
    7779|----------------
    7880{{{#!td
     81enhancement
     82}}}
     83{{{#!td
     84An '''enhancement''' is working on a new set of features in our software. In this case we EXPECT that there has already been a ticket that defines this enhancement. In these cases the ticket is simple:
     85
     86Example ticket: Implement use case: SearchQTLprofiles
     87{{{
     88component: xqtl
     89
     90Implement the enhancement as described in
     91
     92http://www.xgap.org/wiki/XqtlReview#Usecase1.SearchQTLprofiles
     93}}}
     94
     95}}}
     96|----------------
     97{{{#!td
    7998defect
    8099}}}
    81100{{{#!td
    82101
    83 A '''defect''' is a known error in our code base. In this case the ticket MUST describe what you need to do to reproduce the defect. If possible you will first create a UnitTest that shows the bug so that it can never come back without us knowing.
     102A '''defect''' is a known error in our code base. In this case the ticket MUST describe what you need to do to reproduce the defect and you MUST create a test that shows the problem. If possible you will first create a UnitTest that shows the bug so that it can never come back without us knowing.
    84103
    85 Example ticket:
     104Example ticket: Fix JPA if primary key is not named 'id'
    86105{{{
     106component: molgenis
    87107
    88108Why or for whom?
    89 This ticket is a showstopper for ticket #1 in COL7A1
     109This ticket is a showstopper for ticket xyz.
    90110
    91111Expected output?
    921121. checkout molgenis and molgenis_test
     1132. add a new <entity> with a <field name="myid" type="autoid"/>
    931142. generate code
    94 3. run handwritten/tests/TestThisBug.java without errors
     1153. run build.xml without errors
    95116
    96117Action plan?
    97 The current error log is as follows:
    98 <paste of error log>
     118Correct generators to get rid of compile errors.
    99119
    100 Evaluation plan?
    101 run handwritten/tests/TestThisBug.java without errors
     120Evaluation method?
     121UnitTest. If it is a user interface error you have to describe the procedure here.
    102122
    103123}}}
     
    110130{{{#!td
    111131A '''test''' is a special ticket to move the todo of 'testing' an enhancement or bugfix to others in the team. Usually it only refers to the other ticket where the actual bug/enhancement is described. Also newly reported bugs may first need a test case before the tickets can be changed into a bugfix.
     132
     133Example ticket:
     134{{{
     135Why or for whom?
     136We got a report stating that the REST api doesn't work from Java client
     137
     138Expected output?
     139Have a test case that uses the REST api and succeeded/fails
     140
     141Action plan?
     142Create a small REST client
     143
     144Evaluation method?
     145Feed back to the bug reporter what we found and what actions we will take.
     146}}}
     147
    112148}}}
    113149