Correctly Logging a Known Issue (KI) Bug

When to Use This

Steps to Follow

1. Open the Tracker

2. Do Not Use the KI Label as the Bug ID

3. Find the Original Bug ID

4. Log the Bug on the Platform

Example

Common Mistakes to Avoid

Do’s and Don'ts

Linking failed tests to existing Known Issues (KI) ensures bugs are reported accurately. This prevents duplicate submissions and allows the team to focus on new or unresolved issues instead of revisiting known problems.

When to Use This

Use this procedure whenever a test fails due to a bug already listed in the Known Issues section. Correctly linking to the original bug keeps project data clean and speeds up the review process for everyone.

Steps to Follow

1. Open the Tracker

• Access the tracker containing the Known Issues (KI) list.

• Search for the issue that matches the reason your test failed.

2. Do Not Use the KI Label as the Bug ID

• Avoid entering the KI label itself as the bug ID.

• Example: PWT-170-KI-1 is not valid.

• The -KI-1 part is only a temporary label for the current test cycle; it is not the original bug reference.

3. Find the Original Bug ID

• Expand the KI entry in the tracker.

• The original bug ID is usually written in brackets within the summary or description, e.g.:

  [GAT-PWT-134-2]

• Use this as the correct, traceable bug ID.

  • Example: PWT-134-2

4. Log the Bug on the Platform

• Return to the testing platform where the test failed.

• When asked for the bug reference, enter the original bug ID (e.g., PWT-134-2).

• Do not use the KI label (e.g., PWT-170-KI-1).

Tip: Always double-check the original bug ID to ensure accurate reporting and proper traceability.

Example

• Current Test Cycle: PWT-170

• Known Issue Listed: PWT-170-KI-1

• Original Bug ID (after expanding the Known Issue): PWT-134-2

• What to Log in the Platform: PWT-134-2 ✅

 

Common Mistakes to Avoid

• Logging the KI label instead of the original bug ID
  Example of incorrect entry: PWT-170-KI-1
  Always use the original bug ID found inside the KI entry.

• Not expanding the Known Issue entry
  Testers often miss the original bug ID because they only read the title.
  Always open/expand the issue to see the full summary and description.

• Assuming every KI belongs to the current test cycle
  Some Known Issues originate from previous test cycles.
  Always check the cycle reference and confirm you are linking to the correct bug.

Do’s and Don'ts

✅ Do’s

• Expand each Known Issue to view full details and locate the original bug ID.

• Use the correct original bug ID (e.g., PWT-134-2) when submitting your report.

• Double-check the cycle reference to ensure you are linking your result to the correct Known Issue.

❌ Don’ts

• Don’t log the KI label (e.g., PWT-170-KI-1) as the bug ID, it is not traceable.

• Don’t assume every KI is from your current cycle, some may be carried over.

• Don’t skip reviewing the summary/description, this is where the original bug ID is always listed.