Implementation Review

When reviewing a PR we will be using SR App and the first step is to checkout the module branch into SR App, start MAMP, and open the SR App repo in your code editor.

Review Checklist

• Check JSON using https://jsonlint.com

• Make sure JSON and template are using tabs for indentation and spaces for inline indentation (used only in attributes) — PROTIP: if you select all in Sublime it’s easy to see tabs and spaces

• If module is using repeaters make sure groups have ids (https://leanlabs.slack.com/archives/C0291BP58/p1529349017000113)

• Check markup for consistency (spaces where required, remove unnecessary spaces)

• Check if module has any dependencies and make sure these are added to files (JSON)

• Skim through class names and make sure names are consistent

• Deploy module to my own test portal using SR App

• Check module in design manager. If HS upgrade popup is triggered then there’s a problem with upgrading the module, usually related to unsupported content in JSON fields

• Add module to page and test all fields / attributes / selects

• Check if all content that should be editable is actually editable

• Check if help text is clear and you feel a new user can navigate it

• Check if module works fine with multiple instances on the page

• If module is using placeholder images, test with actual images

• Resize browser at different sizes and check if module displays correctly

• Check on iPhone / iPad if module has anything that’s device specific

• If module has placeholder content / images we need to replace these. Add them to the LL portal file/sr-assets/pattern-library/sr-module-name-01/ and also replace them in the JSON

• Screenshot the module at 2880 x module-height and save this as an optimised jpeg (quality 50%) locally to SR App/public/module-previews/sr-module-name-01.jpg

• If you’ve done any changes, make sure to commit & push

• Go to Gitlab, find the PR and merge and remove source branch

Once the PR has been merged

• In Sourcetree checkout back to master, pull, and remove the local module branch you have checked out

• Commit and push the updated submodule branch to Launchpad Starter v2 (e.g. “New module: SR Footer 02”)

• Commit and push the updated submodule branch + module preview to SR App (e.g. “New module: SR Footer 02”)

Notify All GDD Members in Slack with a screenshot of the new module & link (or make a deploybot ping that ANYONE on our team could see and understand, @’ing all stakeholders to Sprocket Rocket).

Common PR notes

Mixed use of tabs / spaces. I have updated the template but please use tabs for indentation and spaces for inline indentation (e.g. attributes at the top of the module).

Having multiple instances of the same module on the page doesn’t work. This isn’t something I’ve been testing as part of PR Review so far but will do moving forward.

Module dependencies need to be added to sr-templates/sr-assets/pattern-library/[module-name] and referenced in the JSON

Module dependencies need to be added to sr-templates/sr-assets/pattern-library/[module-name] and referenced in the JSON

Markup inside of HubL tags needs to be indented, same applies to and tags — fixed

JSON category need to be a number not a string and needs to be outside of custom_module — fixed