ENCODE code review process

From genomewiki
Jump to navigationJump to search

ENCODE Wranglers

NOTE that sometimes ENCODE Developers perform wrangling duties -- when they do, the first two rules apply to them as well.

  • When reviewing a wrangler's check-ins, you must thoroughly check: .daf, scripts (perl, python, etc.)
  • When reviewing a wrangler's check-ins, for the sake of consistency and spreading general knowledge about the project, you should lightly check html, configuration and notes files such as: .ra, notes, .txt, .html
  • Until further notice, Kate will review wrangler's code (.c) check-ins.

ENCODE Developers

  • When reviewing an ENCODE developer's check-ins, don't gloss over ENCODE pipeline edits.
  • When reviewing an ENCODE developer's check-ins, you do not need to review edits to the cv.ra file.

ENCODE QAers

NOTE that as ENOCDE QAers do the actual QA of the tracks they will, by default, check all other changes that have been made by any ENCODEr to .ra and .html files.

  • ENCODE QAers will review all check-ins (.html, .ra, etc) *except* edits to cv.ra.

cv.ra file

  • CV Maven (Jeff) will review all cv.ra commits from the previous week, on the alpha version.
  • In separate processing, cv maven will be periodically copying changes from alpha to beta, when things look stable. They will use a diff on alpha and beta to make an extensive commit message about the types of changes being committed. This will allow CV QA to have a summary of the changes they are reviewing.
  • CV QA (Venkat) will review CV Maven's cv.ra commits from the previous week, on beta.
  • When CV QA finds issues, CV Maven will address the issues both on alpha and beta.
  • Once CV QA approves of the changes in beta/cv.ra, she will copy it to public/cv.ra and make public, thereby releasing the changes to the public. The next time trackDb & friends is pushed, the changes to cv.ra will be released. No review of changes to public/cv.ra is necessary since these exact changes were reviewed by CV QA in beta/cv.ra and CV Maven in alpha/cv.ra.