Pre-QA: Difference between revisions

From Genecats
Jump to navigationJump to search
(added browser QA category)
(Updated hgwdev links to .gi, all links validated)
 
(25 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=About Pre-QA=
=About Pre-QA=
Preliminary QA, or pre-QA, is the initial review ENCODE tracks undergo. The pre-QAer mainly checks hgTrackui (functionality and content), hgFileUi, and the index page to make sure all the necessary components are in place, takes a first pass at editing the description, and checks for basic functionality. Hopefully pre-QA will speed up the QA of ENCODE tracks.
Preliminary QA, or pre-QA, is the initial review that tracks undergo. The pre-QAer mainly checks hgTrackUi (functionality and content), and the index page to make sure all the necessary components are in place, takes a first pass at editing the description, and checks for basic functionality. The goal is for pre-QA to get tracks ready for full QA from a QA staffer.


=Intro to Pre-QA Resources=
=Intro to Pre-QA Resources=
Here is a brief introduction to the resources used in pre-QA
Here is a brief introduction to the resources used in pre-QA:
==Redmine==
==Redmine==
[http://redmine.soe.ucsc.edu Redmine] is our tracking system. This is where we track new tracks for release, features, bugs and documentation changes, and this is where pre-QAer enters any feedback about the tracks. When pre-QA is complete, you'll note this in the redmine ticket.
[http://redmine.soe.ucsc.edu Redmine] is our tracking system. This is where we track new tracks for release, features, bugs and documentation changes, and this is where pre-QAer enters any feedback about the tracks. When pre-QA is complete, you'll note this in the redmine ticket by clicking on the "Passed Pre-QA" checkbox.


A couple notes about using Redmine:
A couple notes about using Redmine:
* When replying to a redmine update/issue via email, use "Reply" rather than "reply all"
* When replying to a redmine update/issue via email, use "Reply" rather than "Reply All"
* Delete all text and enter your message (remove all of the previous thread)
* Delete all text and enter your message (remove all of the previous thread)
* For more info see the [http://redmine.soe.ucsc.edu/projects/genomebrowser/wiki Redmine wiki]
* For more info see the [http://redmine.soe.ucsc.edu/projects/genomebrowser/wiki Redmine wiki]


==PushQ==
==PushQ==
The [http://hgwbeta.cse.ucsc.edu/cgi-bin/qaPushQ pushQ] is our queue of tracks that are ready for QA. This is where you will figure out which tracks to review. You will only be working on the tracks listed in the "A" section (top-most section). When you've completed pre-QA, you'll put a note in the the "Notes" section.
'''Browser Project'''
* The [http://hgwbeta.cse.ucsc.edu/cgi-bin/qaPushQ pushQ] is the Browser project's queue of tracks that are ready for QA. If you are working on the Browser project, this is where you will figure out which tracks to review. You will only be working on the tracks listed in the "A" section (top-most section).


==ENCODE QA wiki==
'''ENCODE Project'''
The [[ENCODE QA]] wiki page is where we keep the step-by-step instructions for QAing an ENCODE track. For pre-QA, you'll work on the [[ENCODE QA#hgTrackUi|hgTrackUi]] and [[ENCODE QA#Files|Files]] (except 8.1.1) sections.
*The ENCODE project now has its pushQ integrated into redmine: [http://redmine.soe.ucsc.edu/projects/encode-wrangling/issues?query_id=206 ENCODE PUSH-Q]. This is the ENCODE project's queue of tracks that are ready for QA and is where you'll find tracks to review. You will be reviewing tracks in the "Approved" section of the list.
 
==QA wiki pages==
;Genome Browser QA wiki:
The [[New_track_checklist]] wiki page is where we keep the step-by-step instructions for QAing a Genome Browser track. The steps on that page that should be done by a pre-QAer are marked "(pre-QA)".
 
;ENCODE QA wiki:
The [[ENCODE QA]] wiki page is where we keep the step-by-step instructions for QAing an ENCODE track. For pre-QA, you'll work on the [[ENCODE QA#hgTrackUi|hgTrackUi]] and [[ENCODE QA#Files|Files]] (except 8.1.1) sections.  


==hgwdev==
==hgwdev==
[http://hgwdev.cse.ucsc.edu/cgi-bin/hgGateway hgwdev] is our test browser, which you'll use for pre-QA. The easiest way to get to the track control & description page (hgTrackUi) is via the [http://hgwdev.cse.ucsc.edu/cgi-bin/hgTracks?db=hg19&hgt_tSearch=1 track search].
[http://hgwdev.gi.ucsc.edu/cgi-bin/hgGateway hgwdev] is our test browser, which you'll use for pre-QA. The easiest way to get to the track control & description page (hgTrackUi) is via the [http://hgwdev.gi.ucsc.edu/cgi-bin/hgTracks?db=hg19&hgt_tSearch=1 track search].


=Pre-QA Step-by-Step=
=Pre-QA Step-by-Step=
==Claim track in PushQ==
==Claim track in PushQ==
Pick a track from the PushQ (ignore anything with "FIX" in the title) and claim it:
::(ENCODE Pre-QA skip)
 
Pick a track from the PushQ that is not claimed (ignore anything with "FIX" in the title) and claim it:
# Click on the Id number, click "Lock"
# Click on the Id number, click "Lock"
# Enter your name in the "reviewer" section
# Enter your name in the "reviewer" section
Line 30: Line 40:


==Claim the redmine ticket==
==Claim the redmine ticket==
'''Browser Project'''
# Sign into redmine
# Sign into redmine
# Enter a "#" sign followed by the ticket number in the search field (e.g. #4893)
# Enter a "#" sign followed by the ticket number in the search field (e.g. #4893)
# Add the current "Assigned to" person as a watcher (on the far left, next to "Watcher" click add, select their name and click "Add")
# Add the current "Assigned to" person as a watcher (on the far left, next to "Watcher" click add, select their name and click "Add")
# Add QA team lead as a "Watcher"
# Click "update" and change the "Assigned to" to yourself & click "submit"
# Click "update" and change the "Assigned to" to yourself & click "submit"
'''ENCODE Project'''
# Sign into redmine and go to the redmine [http://redmine.soe.ucsc.edu/projects/encode-wrangling/issues?query_id=206 ENCODE PUSH-Q]
# From the "Approved" section, select the highest priority/top-most track that hasn't yet passed Pre-QA (you'll know by the 'Passed Pre-QA' column)
# Add the current "Assigned to" person as a watcher (on the far left, next to "Watcher" click add, select their name and click "Add")
# Add QA team lead as a "Watcher"
# Click "update" and change the "Assigned to" to yourself & click "submit"
==Find track in browser & go to hgTrackUi==
==Find track in browser & go to hgTrackUi==
# Go to [http://hgwdev.cse.ucsc.edu/cgi-bin/hgGateway hgwdev]
# Go to [http://hgwdev.gi.ucsc.edu/cgi-bin/hgGateway hgwdev]
# Set the 3 drop-down menus to the following (if they aren't already: Mammal, Human, Feb.2009 (GRCh37/hg19)
# Set the 3 drop-down menus to the correct assembly (e.g. Mammal, Human, Feb.2009 (GRCh37/hg19).  See the [http://hgwdev.gi.ucsc.edu/FAQ/FAQreleases.html#release1 list of assemblies].
# Click the "track search" button (also, here is a direct link to [http://hgwdev.cse.ucsc.edu/cgi-bin/hgTracks?db=hg19&hgt_tSearch=1 hg19 track search])
# Click the "track search" button (also, here is a direct link to [http://hgwdev.gi.ucsc.edu/cgi-bin/hgTracks?db=hg19&hgt_tSearch=1 hg19 track search])
# Enter the name of the track (e.g. Broad HMM) and click "search" button
# Enter the name of the track (e.g. Broad HMM) and click "search" button
# Click the "folder/wrench" icon next to your track
# Click the "folder/wrench" icon next to your track


==Pre-QA hgTrackUi==
==Follow Pre-QA Steps for your Project==
Follow the [[ENCODE QA#hgTrackUi|hgTrackUi]] wiki section
* For the Genome Browser, follow steps marked "Pre-QA" on [[New_track_checklist|this]] page.
* skip [[ENCODE QA#Labels|Labels]] section
* For the ENCODE project, follow this [[ENCODE_Pre-QA|page]].
 
==Pre-QA Files==
Follow the [[ENCODE QA#Files|Files]] wiki section,
* skip the [[ENCODE QA#File Count|File Count]] sub-sections. Instead, just compare that file count on hgFileUi and index page match.


==Update Redmine ticket & Get fixes==
==Update Redmine ticket & Get fixes==
Enter any issues in the redmine ticket for that track (can be done as you pre-QA).
Enter any issues in the redmine ticket for that track (can be done as you pre-QA).
# Go to redmine to your "My Page" and select the appropriate ticket.
# Go to redmine to your "My Page" and select the appropriate ticket.
# Click "update", enter your comments. At the bottom, where you see "Assign question to," enter the wrangler (person you added as watcher, also listed as the "Sponsor" in the pushQ), then click "preview" to see how your comment will look, you can edit more, click "Submit" when satisfied.
# Click "update", enter your comments. At the bottom, where you see "Assign question to," enter the developer/wrangler (person you added as watcher, also listed as the "Sponsor" in the pushQ), then click "preview" to see how your comment will look, you can edit more, click "Submit" when satisfied.
==Note Pre-QA Pass in PushQ and Redmine==
 
==Note Pre-QA Pass in Redmine and PushQ==
Once you have completed pre-QA and all issues you found have been addressed/fixed:
Once you have completed pre-QA and all issues you found have been addressed/fixed:
# Add comment to redmine ticket, "Passed pre-QA" and reassign to wrangler
# Check the "Passed pre-QA" check-box in the redmine issue and remove your name from the "Assigned to" field of the issue.
# Add comment to 'Notes' section of PushQ entry, "<date> Passed pre-QA (<name>)"
# Remove your name from the "reviewer" field in the pushQ entry.


[[Category:Browser QA ENCODE]][[Category:Browser QA ]]
[[Category:Browser QA ENCODE]][[Category:Browser QA]]

Latest revision as of 18:55, 29 August 2018

About Pre-QA

Preliminary QA, or pre-QA, is the initial review that tracks undergo. The pre-QAer mainly checks hgTrackUi (functionality and content), and the index page to make sure all the necessary components are in place, takes a first pass at editing the description, and checks for basic functionality. The goal is for pre-QA to get tracks ready for full QA from a QA staffer.

Intro to Pre-QA Resources

Here is a brief introduction to the resources used in pre-QA:

Redmine

Redmine is our tracking system. This is where we track new tracks for release, features, bugs and documentation changes, and this is where pre-QAer enters any feedback about the tracks. When pre-QA is complete, you'll note this in the redmine ticket by clicking on the "Passed Pre-QA" checkbox.

A couple notes about using Redmine:

  • When replying to a redmine update/issue via email, use "Reply" rather than "Reply All"
  • Delete all text and enter your message (remove all of the previous thread)
  • For more info see the Redmine wiki

PushQ

Browser Project

  • The pushQ is the Browser project's queue of tracks that are ready for QA. If you are working on the Browser project, this is where you will figure out which tracks to review. You will only be working on the tracks listed in the "A" section (top-most section).

ENCODE Project

  • The ENCODE project now has its pushQ integrated into redmine: ENCODE PUSH-Q. This is the ENCODE project's queue of tracks that are ready for QA and is where you'll find tracks to review. You will be reviewing tracks in the "Approved" section of the list.

QA wiki pages

Genome Browser QA wiki

The New_track_checklist wiki page is where we keep the step-by-step instructions for QAing a Genome Browser track. The steps on that page that should be done by a pre-QAer are marked "(pre-QA)".

ENCODE QA wiki

The ENCODE QA wiki page is where we keep the step-by-step instructions for QAing an ENCODE track. For pre-QA, you'll work on the hgTrackUi and Files (except 8.1.1) sections.

hgwdev

hgwdev is our test browser, which you'll use for pre-QA. The easiest way to get to the track control & description page (hgTrackUi) is via the track search.

Pre-QA Step-by-Step

Claim track in PushQ

(ENCODE Pre-QA skip)

Pick a track from the PushQ that is not claimed (ignore anything with "FIX" in the title) and claim it:

  1. Click on the Id number, click "Lock"
  2. Enter your name in the "reviewer" section
  3. Click "submit"
  4. Determine the redmine ticket number for next step by scrolling down to the notes section.

Claim the redmine ticket

Browser Project

  1. Sign into redmine
  2. Enter a "#" sign followed by the ticket number in the search field (e.g. #4893)
  3. Add the current "Assigned to" person as a watcher (on the far left, next to "Watcher" click add, select their name and click "Add")
  4. Add QA team lead as a "Watcher"
  5. Click "update" and change the "Assigned to" to yourself & click "submit"

ENCODE Project

  1. Sign into redmine and go to the redmine ENCODE PUSH-Q
  2. From the "Approved" section, select the highest priority/top-most track that hasn't yet passed Pre-QA (you'll know by the 'Passed Pre-QA' column)
  3. Add the current "Assigned to" person as a watcher (on the far left, next to "Watcher" click add, select their name and click "Add")
  4. Add QA team lead as a "Watcher"
  5. Click "update" and change the "Assigned to" to yourself & click "submit"

Find track in browser & go to hgTrackUi

  1. Go to hgwdev
  2. Set the 3 drop-down menus to the correct assembly (e.g. Mammal, Human, Feb.2009 (GRCh37/hg19). See the list of assemblies.
  3. Click the "track search" button (also, here is a direct link to hg19 track search)
  4. Enter the name of the track (e.g. Broad HMM) and click "search" button
  5. Click the "folder/wrench" icon next to your track

Follow Pre-QA Steps for your Project

  • For the Genome Browser, follow steps marked "Pre-QA" on this page.
  • For the ENCODE project, follow this page.

Update Redmine ticket & Get fixes

Enter any issues in the redmine ticket for that track (can be done as you pre-QA).

  1. Go to redmine to your "My Page" and select the appropriate ticket.
  2. Click "update", enter your comments. At the bottom, where you see "Assign question to," enter the developer/wrangler (person you added as watcher, also listed as the "Sponsor" in the pushQ), then click "preview" to see how your comment will look, you can edit more, click "Submit" when satisfied.

Note Pre-QA Pass in Redmine and PushQ

Once you have completed pre-QA and all issues you found have been addressed/fixed:

  1. Check the "Passed pre-QA" check-box in the redmine issue and remove your name from the "Assigned to" field of the issue.
  2. Remove your name from the "reviewer" field in the pushQ entry.
Retrieved from "https://genomewiki.ucsc.edu/genecats/index.php?title=Pre-QA&oldid=4800"