Po.et Documentation
Technical documentation for the Po.et Network

About Po.et
Use Po.et

Bug Reporting Checklist

Bugs will inevitably be found in our software, whether internally by ourselves or from Po.et users. The checklists below will be introduced into the public-facing repos so that bug reporters understand what they need to do to file a helpful and complete bug report (see the User Checklist below).

Once a bug report has been filed, the QE Review Checklist will be used internally to ensure the bug is triaged correctly and that any bugs related to security are escalated. The following sequence diagram shows the flow for handling bug reports.

User Checklist

  1. What result were you expecting?
  2. What result did you actually observe, and what leads you to believe this indicates a bug?
  3. How can you reliably reproduce the observed result?
    1. Versions of all apps/packages/testing tools involved
    2. Any background information on the environment where or about the circumstances in which the bug occurred (e.g., are you behind a corporate firewall)
    3. Ordered list of exact steps to reproduce the observed result (screenshots/videos are welcome only if they supplement the list - do not send them in by themselves without written instructions for reproducing the bug)
  4. Have you tested the steps for reproduction in 3.3 above to confirm they reliably produced the bug? If they do not, we will not be able to troubleshoot the issue.

QE Review Checklist

  1. Is the issue a potential security vulnerability (if so, escalate and treat with highest priority)?
  2. Has the user provided examples of both the expected result and the actual result?
    1. Do the examples infer, or has the user provided an explanation of why they indicate, a bug?
  3. Has the user provided a detailed description on how to reliably reproduce the bug?
    1. Version of all apps/packages involved
    2. Exact circumstances that caused the bug (include mention of any tools used, local settings such as a firewall, etc.)
    3. Ordered list of steps to reproduce (screenshots/video are encouraged to supplement the list, but not replace it)
  4. Can you reproduce the issue by following the steps provided by the user?