Bug Verification and Identification Checklist

Step 1: Cache Buster

• Double check that the page saved correctly.
• Remove any potential lingering code and clear custom CSS.
  • To clear custom CSS, click the “Clear Custom CSS” link in the top Wordpress bar when logged in.
  • Note: This removes all custom CSS. Be sure that you do not have any intended custom CSS before using this option. If you suspect it is a custom CSS issue and you have needed CSS contact a dev.
• Clear Wordpress Cache
  • Clear Wordpress cache using the “Clear Cache” link in the top Wordpress bar when logged in.
• Clear your local cache, hard refresh your page, and/or check in incognito mode.
  • How to clear browser cache for all major browsers
  • Hard refresh for Mac: CMD + SHIFT + R

Step 2: Service Status Check

• In some instances, the bug could be caused by an outage with a third-party system we use. If you notice the issue occurring across a specific type of content, or out of the blue, it could be a disruption with one of our service providers. Check the pertinent status page for confirmation.
  • CloudFlare – our CDN / nameserver provider
    • https://www.cloudflarestatus.com/
  • Imgix – our Image hosting provider
    • https://status.imgix.com/
  • Slack channel #ambulance for dashboard, payment, email, and other third-party related status incidents.

Step 3: Site-Specific Replication

• Does it occur anywhere else on the same site?
  • Is it restricted to a specific page, page type, block, or row?
• Does it occur on the same site in a different browser?
  • Does it occur in Safari but not Chrome? Is it on mobile Safari but not when you make your browser small?

Step 4: Theme-Specific Replication

• Does it occur on any other sites that are running the same theme?
  • Are the configurations the same? Note any differences between the two. Does one set of configurations work, but the other does not?

Step 5: Second-Eyes Replication**

• ** This section is not required for every bug. However, if you have any doubts at all, it is always better to ask someone else. Use your best judgment.
• Can your neighbor make it happen?
  • Explain the bug and the steps to make the bug occur. Does it happen for them?
• Checks team check
  • When in doubt, ask someone on the checks team or someone who is experienced working within the theme. Do they think it’s a bug?

Let’s gather the necessary information.

Step 1: Visual Proof

• Grab a screenshot of the bug(or a video if applicable).
• If deemed necessary, grab screenshots from the various other sources you checked during verification.
• Helpful tips:
  • How to take a screenshot on a Mac
  • How to take a screenshot on Windows 10
  • Full Page Screen Capture Using DevTools: Chrome, FireFox, Safari
  • Full Page Screen Capture Plugins
    • Chrome
    • FireFox
  • Video
    • Built in Mac programs
    • RecordIt * [Loom] (https://www.loom.com/)

Step 2: Tech Info

• Copy down all affected URL(s).
• Record what browser you are using and the version too, especially if you haven’t updated your browser in a while.
• Note the theme(s) in which the bug is happening.
• Helpful tips:
  • How to find browser version number, all major browsers
  • How to find os version, Windows, Mac, Mobile Providers

Step 3: Steps to Reproduce Info

• Document the steps needed to reproduce the bug. Be sure to note configuration options, especially if the bug requires certain configurations across different theme locations.
• Be sure to include any relevant information about replication learned in the prior step.
• Be thorough. It’s better to give too much information rather than not enough.

Step 4: Submit your Bug

• Airtable Form

Summary

• The summary should be unique and identifiable.
• Examples Bad: “Buttons are broken / Buttons don’t work right” Good: “Links aren’t opening in new tabs.”

Description

Information

• Give us the 4-1-1 on the bug. Include information gathered in the prior step. This should be all-encompassing: describe the bug, where it’s occurring, and how you are causing it to occur. If it makes sense, add what you expect to happen as well.
• Examples
  • Bad: “sometimes when I click buttons they don’t work”
  • Good: “On activity pages, when I add a link in a WYSIWYG, click the ‘link to new tab’ checkbox, and save the page, the link is opening in the same tab. I verified that it is working correctly on regular pages, just not on activity pages. All browsers have the same issue, and so do other MK sites I checked.”

Steps to Reproduce

• Can be simple:
  • “click URL, see issue”
• Can be complex
  • Go to URL in Safari
  • Edit Activity Page
  • Create link in WYSIWYG copy with new tab link checked.
  • Save
  • Go to page and click the link
• Examples
  • Bad: “go to a page with a button on it, see that it’s broken”
  • Good: see steps 1-2

Actual Result

• Describe here the result of the bug, for example:
  • Does the application crash?
  • Does nothing happen at all?
  • Is an error displayed?

Expected Result

• This is the result or output that was expected or intended.

Severity & Priority

• Critical/Blocker: This is reserved for issues that make the application unusable or cause serious data loss.
• High: When the bug affects a major feature and there is no workaround or the available workaround is very complex.
• Medium: The bug effects a minor feature or effects a major feature but has an easy enough workaround to not cause any major inconvenience.
• Low: This is used for bugs that don’t significantly affect the user experience, like minor visual bugs.

Frequency of the bug (conditional field – FH Sites)

• Please select how many sites this bug is approx. affecting:
  • More than half of FH sites (wide-spread bug)
  • Many FH sites but less than half (fairly common)
  • Only a few FH sites (very specific/rare bug)

Location (URL)

• Can be single, but should be multiple if issues exist across themes.
• Examples
  • Bad: “look at a site”
  • Good: https://amigotourscancun.com/nightlife-experiences/pirate-ship-cancun-premium-tour/

Did you replicate the bug on https://bug.fareharbor.me/ or on different URL? (conditional field – FH Sites)

• If Yes, please share the replicated URL
• If No, please explain why it could not be replicated

Screenshots

• Images
  • Supports: PNG, JPEG, GIF, TIFF, most major image types
  • Does Not Support: SVG, PDF
• Video
  • Supports: MP4, MPG, AVI, MOV, most major video types
  • Does Not Support: SVG
• URL
  • If you use an online program like Recordit, you can paste the generated URL rather than uploading a file.
  • If using Google drive, Dropbox, or any other file hosting sites, be sure that permissions are set for others to view.
• Helpful Tips
  • Image Type Conversion Tool
  • Video Type Conversion Tool
  • Any Type Conversion Tool
  • How to Share via Google Drive
  • How to Share via Dropbox

Environment

• Browser
  • Include browser name and version number
  • Especially if you have a browser update to run!
  • Examples
    • Chrome 36.203.1.3.2
    • Safari 11.01
    • Mobile Safari
• OS
  • In most cases “Mac” is fine.
  • Mostly applicable for mobile, with various iOS/Android versions or for Windows/IE combinations.
  • Examples
    • iOS 12.0.1
    • Windows 10
    • Mac – High Sierra
    • Android Oreo 8.1

• Theme

  • Select theme.
  • or multiple themes, if it is happening on more than one theme

• Device(s)

  • Desktop
  • Mobile
  • Tablet

Additional Information [Optional]

• Anything additional you feel is relevant to share. Maybe you noticed this has always been a problem or that it started yesterday. Perhaps you think it might be related to something you or someone else reported. If there is an error on the page or in the console, plop it here. If you have any institutional knowledge, this would be the place to share.
• Examples
  • “I noticed this stopped working yesterday.”
  • “I know that Sommer had reported something like this before.”
  • “This is super duper urgent. The guy is hella mad.”

• One bug per ticket
• State useful facts, not opinions or complaints
  • This is for Bugs. This does not replace the Idea Box or Custom Requests.
• Flag known additional information
• When in doubt, make sure to ask other people
• Knowledge sharing — we learn best when we work together

Good Bugs

Image	Notes
	What’s Right? * Explains the issue completely * Gives a URL * Gives device/browser details * Provides additional information (the ticket) * Has a screenshot What’s Wrong? * Could include the direct URL to the page in question * Not a bug – could have been solved by asking a senior member of the Sites Team
	What’s Right? * A good title * A good summary * Provides URL * Gives steps to recreate a complex issue * Has multiple screenshots showing expected vs. actual * Provides additional information

Bad Bugs

These are all old, ported over bugs. Using for example purposes only.

Image	Notes
	What’s Right? * A good title * Has a screenshot What’s Wrong? * Details are sparse * References someone who doesn’t work here anymore as the information source * Supporting screenshot is useless without context * No URLs
	What’s Right? * A good title * Includes the full error What’s Wrong? * No details about what caused this error to occur * No details about where this issue is occurring * No details at all