Add-ons/Reviewers/Guide/Tools

From MozillaWiki
< Add-ons‎ | Reviewers‎ | Guide(Redirected from AMO/Reviewers/Guide/Tools)
Jump to: navigation, search

New reviewers need to be given permission by an admin to gain access to the review tools. Once the admin has given you permission, you should see an Editor Tools item in the Tools menu on the top right of the AMO homepage. Editors is an old name given to our team, still used around the site and on our mailing lists. We prefer the term Reviewers now.

Editor Tools menu item

If the Editor Tools option doesn't appear on the dropdown menu, try logging out and logging back in. If it still doesn't appear, contact the admin who should have given you access. Clicking on the menu item will take you to the reviewers homepage. This page displays the state of the review queues along with some stats.

Basic tools

Announcement

The announcement is maintained by admins, and it appears in a box at the top of all pages. It usually has important messages, so make sure to read it if it changes.

Queue summary view

The homepage has a handy summary view of the queues, giving a clear visual representation on how we stand with reviews. Hovering over the segments indicates the amount and percentages of reviews on each category. This should give you a good idea where to focus.

Queue summary

The colors represent:

  • Red: reviews waiting for over 10 days.
  • Yellow: between 5 and 10 days.
  • Green: less than 5 days. We like green :).

Queues

The review queues are the centerpiece of the reviewer tools. They can be accessed from the queues menu. There are 5 queues:

  • Full reviews: new add-ons that have been submitted for review.
  • Pending updates: new versions of add-ons that have passed review before.
  • Moderated reviews: user comments (called reviews on AMO, for maximum confusion) flagged for moderation.
Review queues menu

The queues will be covered in detail throughout this guide.

Performance

The performance tools display your review stats and compares them with team averages.

Logs

On these pages you can look and search for previous reviews performed by you or other team members.

The Review Queues

The review queues look like this:

Queues.png

The add-on name and version number are links to the review page for each add-on. They are blurred in the image to protect the developers' privacy. A lock icon will appear to their left if another reviewer is looking at that add-on. In the Flags column, hovering over any icon should tell you what it means. The last icon in the column (white page with a pencil) shows you the Version Notes and Notes to Reviewer if you click on it.

You will sometimes see add-ons near the top of the queues that have been waiting for long times. They are usually flagged for admins or are waiting for something to happen before they can be handled. Skip those and focus on the add-ons near the middle or bottom, especially if you're only getting started. You can work your way up as you become more experienced.

Review Pages

The top of review pages look like the top of add-on listing pages, including all the information provided to users about the add-on. Below the add-on description is where the review-specific information appears.

First, there might be an "Add-on user change history" section:

[Screenshot of a "Add-on user change history" section that exists for add-ons that had changes in ownership]

This lists all the ownership changes this add-on has had, if any. This is important because an add-on changing hands could mean that the new owner will include vastly different features or monetization to the add-on. Be careful when reviewing add-ons that recently had ownership changes.

Then there's the Add-on History:

Review page

This shows the most recent versions and their review resolutions. This is very valuable information when reviewing an add-on. You need to make sure that issues brought up in the last reviews have been addressed. The last 3 are shown by default, but you can click on the previous ones to expand them.

The All Platforms link points to the file to review, generally an XPI. The Validation link will run the automatic code validator on that file and show you the results. The Contents link opens the source code viewer, and the Compare link opens the diff viewer, so you can compare the current version with the previous ones.

History entries can have Version Notes and Notes to Reviewers. Version Notes are meant to be public, while Notes to Reviewers are meant for reviewers only. They can include testing information or responses to previous review notes. Since testing information isn't usually version-dependent, we prefer to have those in the Whiteboard field, which you can find at the bottom of review pages. This is a shared field between the add-on developer and the review team, so make sure that testing info is always there and up to date.

Review actions

Near the bottom of review pages you should see a list of review actions:

Possible review resolutions

Clicking on any of them will open a form below it.

The comments textbox is where you should write all of your review notes. There's also a canned response list below it, that contains very useful, reusable snippets of text for your notes. Selecting any of them will add the text to the textbox, wherever the cursor is. You can use as many as you need.

The first two actions will resolve the pending review:

  • Push to Public: the version doesn't have any major problems and it's OK to publish.
  • Reject: the version has problems and must be rejected.

Once a review is submitted, an email including your notes will be sent to the add-on developers. Developers can respond to your review via email, and an admin reviewer might loop you in the discussion if it requires your attention.

The other 3 actions are used on special situations:

  • Request More Information: this allows you to ask the author for information necessary to perform the review, without removing the add-on from the queue. A very common case for this is when the add-on is site-specific and the author didn't provide a test account.
  • Request super-review: this is for cases when you think an admin reviewer should give this add-on a look. Use it for add-ons that appear suspicious or you don't think a regular reviewer can handle. The add-on will remain in the queue, and the developer will be notified, but your notes aren't sent as part of the notification. They're only readable to other reviewers.
  • Comment: this allows you to add a comment that is only readable by other editors. It can have testing information, partial notes that you had from reviewing a version that you couldn't finish, etc.

Next: Reviewing