Activity Library/Editors/Reviewing Guide: Difference between revisions

Line 54:

= Reviewing ~~Add-ons~~ =

= Reviewing Activities =

What are we looking for when reviewing an ~~add-on~~?

What are we looking for when reviewing an activity?

== 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 both platforms.

* 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 0.82+)

* 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?

* 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.

* Non extension types: search engines, language packs, dictionaries and plugins do not need reviews in order to go public.

== Step 3. Functionality ==

* Does it install?

* 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?

* Some addons require configuration or are site specific before they are activated

* Does it seem to break anything?

** Try hitting the home page and performing a search

* Does it generate errors/warnings as you use it? (Look at the Log entry for the activity.)

** Visit, say "espn.com", "cnn.com", "wsj.com" via typing in the URL

** Do a search from the search box

** Try to exercise the add-on (this is specific to the addon)

* Does it generate errors/warnings as you use it?

* For themes, make sure it does not throw any CSS errors

** Bring up Error Console (~~or use~~ the ~~[https://addons.mozilla.org/firefox/addon/1815 Console 2] or~~ the ~~[https://addons.mozilla~~.~~org/firefox/addon/3887 docked JS-console ]extension~~)

== Step 4. Security ==

Line 211:

Line 203:

* 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.

= Moderating Reviews =

@@ Line 54: / Line 54: @@
-= Reviewing Add-ons =
+= Reviewing Activities =
-What are we looking for when reviewing an add-on?
+What are we looking for when reviewing an activity?
 == 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 both platforms.
-* 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 0.82+)
 * 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?
-* 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.
-* Non extension types: search engines, language packs, dictionaries and plugins do not need reviews in order to go public.
 == Step 3. Functionality ==
 * Does it install?
 * 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?
-* Some addons require configuration or are site specific before they are activated
 * Does it seem to break anything?
-** Try hitting the home page and performing a search
+* Does it generate errors/warnings as you use it? (Look at the Log entry for the activity.)
-** Visit, say "espn.com", "cnn.com", "wsj.com" via typing in the URL
-** Do a search from the search box
-** Try to exercise the add-on (this is specific to the addon)
-* Does it generate errors/warnings as you use it?
-* For themes, make sure it does not throw any CSS errors
-** Bring up Error Console (or use the [https://addons.mozilla.org/firefox/addon/1815 Console 2] or the [https://addons.mozilla.org/firefox/addon/3887 docked JS-console ]extension)
 == Step 4. Security ==
@@ Line 211: / Line 203: @@
 * 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.
 = Moderating Reviews =