Describe what you expected

When reporting a bug, please include what you expected to happen. This helps understand if the issue is a deviation from the intended behavior.

Example:

“I expected to be redirected to the dashboard after logging in”.

Describe what actually happened

Along with the expected outcome, explain what actually happened. Did you see an error message? Were you directed to the wrong page? Including a URL, screenshot, or error message can be incredibly helpful.

Example:

“Instead of the dashboard, I received an error saying ‘username not found,’ and it redirects me to [URL]”.

Steps to reproduce the issue

Developers may not always be able to reproduce the bug on their end, so it’s essential to document the steps that lead to the problem.

• Write down what you did right before the issue occurred.

• If possible, simplify the steps to a basic sequence that consistently triggers the bug.

Even if you can’t reproduce the issue every time, it’s still worth reporting. Sometimes multiple reports help uncover the root cause.

Example:

• Go to [URL].

• Enter username and password.

• Click “Log in” button.

Provide Key Details

• Screenshots: Include screenshots of error messages, unexpected behavior, or anything that seems off.

• URLs: If the issue occurs on a web-based platform, include the URL where the error appeared and the URL of the page you were on before the error occurred. This helps us identify the root cause.

• Error Messages: If an error message appears, include the full text in your ticket. Even system-generated error codes can be useful.

• Environment Details: Specify the device, operating system, and browser you’re using. Some bugs are platform-specific, so this information is critical.

Generating a HAR File

For more advanced bug reports, we may ask for a HAR file (a log of network requests). This is often necessary for investigating deeper technical issues.

A HAR file contains data like your cookies and the pages you visited while recording, which could include personal or sensitive information. Be sure to protect your HAR files. You can use Cloudflare’s HAR sanitizer to remove any sensitive data before sharing it.

To generate a HAR file:

• Start by going to the webpage where the issue is happening.

• Click on the three-dot menu (⋮) in the top-right corner of Chrome, then select More Tools > Developer Tools.

• In the panel that opens, select the Network tab. Keep this tab open while you recreate the issue.

• Make sure the record button is red (if not, click it).

• Click the gray circle with a line through it to clear any old logs in the Network tab.

• Check the “Preserve log” option.

• Reproduce the bug.

• Save the file by clicking the download icon.