Changes between Version 7 and Version 8 of MolgenisTicketFaq


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

--

Legend:

Unmodified
Added
Removed
Modified
  • MolgenisTicketFaq

    v7 v8  
    4949== Ticket types ==
    5050
    51 Currently we have four flavors of tickets:
     51Currently we have four flavors of tickets. For each of them examples are shown:
     52|----------------
     53{{{#!td
     54todo
     55}}}
     56{{{#!td
     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.
     58So what you need to do is describe this expected output.
    5259
    53 === defect ===
    54 A defect is a known error in our code base. Therefore the ticket MUST describe what you need to do to reproduce the defect.
    55 ExpeIf possible you will first create a UnitTest that shows the bug so that it can never come back without us knowing.
     60Example ticket:
    5661
    5762{{{
    58 To reproduce the defect:
     63Why or for whom?
     64For medgen and bbmri we want to compare imputation methods Beagle, Impute and MACH.
     65
     66Expected output?
     67An Excel document that describes a comparable percentage correctly estimated SNPs.
     68
     69Action plan?
     70Take existing genotype data from 1M arrays and split the data randomly in two. The first half we input into the impute methods. Then we compare the SNPs called with those actually called on the array and calculate percentage correctly estimated SNPs.
     71
     72Evaluation plan?
     73We will feed back results to Lude and Cisca's teams to evaluate outcomes and if necessary propose further testing.
     74}}}
     75
     76}}}
     77|----------------
     78{{{#!td
     79defect
     80}}}
     81{{{#!td
     82
     83A '''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.
     84
     85Example ticket:
     86{{{
     87
     88Why or for whom?
     89This ticket is a showstopper for ticket #1 in COL7A1
     90
     91Expected output?
    59921. checkout molgenis and molgenis_test
    60932. generate code
    61 3. run handwritten/tests/TestThisBug.java
     943. run handwritten/tests/TestThisBug.java without errors
    6295
    63 The error log is as follows:
     96Action plan?
     97The current error log is as follows:
    6498<paste of error log>
     99
     100Evaluation plan?
     101run handwritten/tests/TestThisBug.java without errors
    65102
    66103}}}
    67104
    68 === Enhancement ===
     105}}}
     106|----------------
     107{{{#!td
     108test
     109}}}
     110{{{#!td
     111A '''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.
     112}}}
    69113
    70114
    71 '''todo''' - these are actions that don't produce code but something else. For example: an excel with quality scores for each NGS lane.
    72115
    73