B2G/QA/Automation/Style Guide/Submission Review
- 1 Submission and Review
Submission and Review
To make sure that we can review your patch as quickly and efficiently as possibly we would like patches to have a single test in them and the necessary changes to the page objects. This also limits the chances of merge conflicts later.
Please refer to this page for gaia patch submission steps.
First of all, make sure above mentioned guidelines are not violated, and check for the following:
Look for transitions that are not waited on
Sometimes tests can intermittently fail. One reason of the failures can be the lack of waits. While reviewing code, check if every event that happens on the screen, is detailed in the Page class. For example: a panel that moves elsewhere, a button that gets enabled after the others, an element that can't be tapped until another is displayed, etc.
Check for change/removal of methods
In some occasions, some old code is removed. While performing you review, make sure there is no other calls to this class or method.If you have applied the patch form the Pull Request,
git grep my_function
Are the locators correct? Could they be improved?
Locators in Gaia are usually either ID, or simple CSS selectors (with either CSS classes or data-l10n-id). Smaller locators are better. If one looks too long or not self-explanatory, don't hesitate to open WebIDE to see the DOM or ask questions in the review.
Are the locators/methods used that were added?
In near future, a linter would also help to enforce it, see: https://bugzilla.mozilla.org/show_bug.cgi?id=1186388
Are workarounds explained in the code file?