2,751
edits
Changes
Activity Library/Editors/Reviewing Guide (view source)
Revision as of 18:30, 4 April 2009
, 18:30, 4 April 2009Activity Team/aslo/Editors/Reviewing Guide moved to Activity Library/Editors/Reviewing Guide
{{draft}}
{{ GoogleTrans-en | es =show | bg =show | zh-CN =show | zh-TW =show | hr =show | cs =show | da =show | nl =show | fi =show | fr =show | de =show | el =show | hi =show | it =show | ja =show | ko =show | no =show | pl =show | pt =show | ro =show | ru =show | sv =show }}
{{ GoogleTrans-en | es =show | bg =show | zh-CN =show | zh-TW =show | hr =show | cs =show | da =show | nl =show | fi =show | fr =show | de =show | el =show | hi =show | it =show | ja =show | ko =show | no =show | pl =show | pt =show | ro =show | ru =show | sv =show }}
{{TOCright}}
{{TOCright}}
== Understanding the UI ==
== Understanding the UI ==
When you click on an add-on to review, you'll see a review page with the following elements:
When you click on an activity to review, you'll see a review page with the following elements:
* Authors - A listing of the add-ons authors with links to their user pages
* Authors – a listing of the activity's authors with links to their user pages
* Categories - A listing of the add-on's categories.
* Categories – a listing of the activity's categories
* Compatibility - A listing of the target applications and their compatible versions
* Compatibility – a listing of the target applications and their compatible versions
* Files - A listing of all files for this version with a link to install and a link to view the source. Only checked versions will be processed. If a checkbox is disabled, the associated file has already been reviewed.
* Files – a listing of all files for this version of the activity with a link to install and a link to view the source (Only checked versions will be processed. If a checkbox is disabled, the associated file has already been reviewed.)
* Action box - this is where you'll push the add-on/version public, retain it in the sandbox, or request super review.
* Action box – this is where you'll push the activity/version public, retain it in the sandbox, or request super review
* Information the author has entered, such as summary, description, version notes, developer comments, EULA, Privacy Policy
* Information the author has entered, such as summary, description, version notes, developer comments, EULA, privacy policy
* Item History - any previous reviews of the add-on. This is important to look at.
* Item History – any previous reviews of the activity
* Previews - display of the add-on's previews
* Previews – display of the activity's previews
== Actions ==
== Actions ==
=== Push to Public ===
=== Push to Public ===
If you are reviewing a pending update, pushing public will cause the sandboxed version of the public add-on to appear on the public side.
If you are reviewing a pending update, pushing public will cause the sandboxed version of the public activity to appear on the public side.
If you are reviewing a nominated add-on, pushing public will cause both the add-on and its most recent version to appear on the public side.
If you are reviewing a nominated activity, pushing public will cause both the activity and its most recent version to appear on the public side.
Your action and comments entered will be e-mailed to the author.
Your action and comments entered will be e-mailed to the author.
If you are reviewing a pending update, retaining in sandbox will keep the version in the sandbox. The author will have to submit another update to be reviewed again.
If you are reviewing a pending update, retaining in sandbox will keep the version in the sandbox. The author will have to submit another update to be reviewed again.
If you are reviewing a nominated add-on, retaining in sandbox will keep the add-on in the sandbox. The author is able to immediately nominate it again. If the author abuses this and does not make any changes, please flag for super review and indicate the reason.
If you are reviewing a nominated activity, retaining in sandbox will keep the activity in the sandbox. The author is able to immediately nominate it again. If the author abuses this and does not make any changes, please flag for super review and indicate the reason.
Your action and comments entered will be e-mailed to the author.
Your action and comments entered will be e-mailed to the author.
=== Request Super-Review ===
=== Request Super-Review ===
Requesting super review will cause the add-on to be flagged for admin review, which will appear in an admin queue and dispatch an e-mail to the administrators.
Requesting super review will cause the activity to be flagged for administrative review, which will appear in an admin queue and dispatch an e-mail to the administrators.
Super review should be requested for the following reasons:
Super review should be requested for the following reasons:
* Security concerns
* Security concerns
* Copyright/trademark concerns
* Copyright/trademark concerns
* Repeatedly nominating add-on without any changes
* Repeatedly nominating activity without any changes
* Add-on contains binary components
* Activity contains binary components
* Other issues that an administrator should look into
* Other issues that an administrator should look into
Remember that your comments go to a *real person*, so try to be friendly.
Remember that your comments go to a *real person*, so try to be friendly.
If you are pushing the add-on public, thank the author for the time and effort they have put in. Remember that they're enhancing the usefulness and the appeal of the products! Tell them which features you like the most, and mention anywhere you think they could improve.
If you are pushing the activity public, thank the author for the time and effort they have put in. Remember that they're enhancing the usefulness and the appeal of the products! Tell them which features you like the most, and mention anywhere you think they could improve.
If you are retaining in the sandbox, be polite in pointing out any problems. Provide suggestions as to what they could do or should fix before re-submitting it and encourage them to re-submit it if it could ever be public. It's also a good idea to tell the author what you liked about the extension/theme even though you've retained it.
If you are retaining in the sandbox, be polite in pointing out any problems. Provide suggestions as to what they could do or should fix before re-submitting it and encourage them to re-submit it if it could ever be public. It's also a good idea to tell the author what you liked about the extension/theme even though you've retained it.
If you think it should be translated, you can add a hint for submitting it to [http://www.babelzilla.org BabelZilla], even if it has no locale structure.
If you think it should be translated, you can add a hint for submitting it to the Localization Team, even if it has no locale structure.
= Reviewing Activities =
What are we looking for when reviewing an activity?
What are we looking for when reviewing an add-on?
== Step 1. Decide on Testing Scope ==
== Step 1. Decide on Testing Scope ==
* If an addon is designated for Firefox + another app, usually, you only need to confirm Firefox
* If an activity is designated for Sugar but also can run outside of Sugar, usually, you only need to test it within Sugar
* If you have two platforms (e.g. Mac + Win or Win + Linux), it would be great to do the majority of the work on Windows and a quickcheck on the secondary platform. Remember 95% of Firefox users are on Windows - so try to hit the major use case.
* If you have Sugar running on multiple platforms, it would be great if you could do some testing on more than one platform (on different hardware, at different screen sizes, on different GNU/Linux distributions)
* For new addons:
* For new activities:
** Examine addon for which version of Firefox it supports (focus on Fx3)
** Examine the activity for which version of Sugar it supports (focus on Sugar 0.82+)
* For updates:
* For updates:
** For addons being updated for Fx3.1, test on Fx3.1 as primary and Fx3 as secondary
** For activities being updated for 0.84, test on 0.84 as primary and 0.82 as secondary
== Step 2. AMO User & Community Feedback ==
== Step 2. ASLO User & Community Feedback ==
* Are there a sufficient number of AMO comments (possibly in other languages)?
* Are there a sufficient number of ASLO comments (possibly in other languages)?
* Are there external reviews that were submitted that show it has some usage?
* Are there external reviews that were submitted that show it has some usage?
* Perform a Google search on the addon's name - gives you a measure of popularity/feedback. See if there are blog posts or the project/company website. Sometimes testimonials are hosted there.
* Perform a Google search on the activity's name – this gives you a measure of popularity/feedback. See if there are blog posts or the project/company website. Sometimes testimonials are hosted there.
== Step 3. Functionality ==
== Step 3. Functionality ==
* Does it install?
* Does it install?
* Does it show up as expected?
* Does it show up as expected?
* Where does it show up? sidebar? Context menu, menu bar, chrome/status area?
* Does it launch?
* Check addon prefs and see if has them - do they seem to work?
* Does it work in multiple languages?
* Does it seem to break anything?
* Does it seem to break anything?
* Does it generate errors/warnings as you use it? (Look at the Log entry for the activity.)
* Does it generate errors/warnings as you use it?
== Step 4. Security ==
== Step 4. Security ==
'''NOTE''': This section needs to be rewritten for the Sugar/Rainbow/Bitfrost context.
=== Does it load remote JavaScript? ===
=== Does it load remote JavaScript? ===
* Deny going public.
* Deny going public.
* A dictionary's "target locale" must be set correctly (editable via the developer tools on AMO).
* A dictionary's "target locale" must be set correctly (editable via the developer tools on AMO).
* The only javascript allowed is in install.js and must only be adding the dictionary (using addDirectory()). The en-US dictionary is a good example. A dictionary is not allowed to modify other settings or defaults.
* The only javascript allowed is in install.js and must only be adding the dictionary (using addDirectory()). The en-US dictionary is a good example. A dictionary is not allowed to modify other settings or defaults.
= Moderating Reviews =
= Moderating Reviews =
* Support questions that also contain reviews – approve
* Support questions that also contain reviews – approve
[[Category:Activity]]
[[Category:Activity Team]]
[[Category:HowTo]]
[[Category:HowTo]]