---
title: "QA Summary Template"
by: "khive-tester"
created: "2025-04-12"
updated: "2025-04-12"
version: "1.1"
description: "Template for creating quality assurance summaries after testing khive components"
---

# Guidance

**Purpose**\
To provide a structured summary of QA findings after running test suites on a
new or updated component.

**When to Use**

- After you’ve executed all relevant unit, integration, performance, or E2E
  tests.
- Before code review or final sign-off.

**Best Practices**

- Be concise but thorough: highlight pass/fail, coverage, any discovered gaps.
- Mark issues as blocking or non-blocking.
- Always verify coverage if required.

---

# QA Summary: [Component/Feature Name]

**Date:** YYYY-MM-DD\
**Tester:** @khive-tester\
**Implementation:** [Link to PR/Branch/Commit SHA]\
**Implementer:** @khive-implementer\
**Related Spec:** `docs/designs/[spec_filename.md]`

## 1. Test Execution Summary

| Test Suite        | Command                           | Status            | Pass / Total | Notes                          |
| ----------------- | --------------------------------- | ----------------- | ------------ | ------------------------------ |
| Unit Tests        | `pytest path/to/tests`            | ✅ PASS / ❌ FAIL | 42/42        | All tests passed               |
| Integration Tests | `pytest path/to/integration`      | ✅ PASS / ❌ FAIL | 12/12        | All tests passed               |
| E2E Tests         | `npm run test:e2e`                | ✅ PASS / ❌ FAIL | 5/5          | All tests passed               |
| Performance Tests | `pytest path/to/perf --benchmark` | ✅ PASS / ❌ FAIL | 2/2          | All performance thresholds met |

**Overall Status:** ✅ PASS / ❌ FAIL

## 2. Test Coverage Analysis

| Module        | Line Coverage | Branch Coverage | Missing Coverage             |
| ------------- | ------------- | --------------- | ---------------------------- |
| `module_a.py` | 95%           | 90%             | Error handling in function X |
| `module_b.py` | 87%           | 82%             | Edge case handling           |

**Overall Coverage:** 92% line, 86% branch\
**Coverage Assessment:** [Are critical paths fully tested? Any major coverage
gap?]

## 3. Specification Compliance

| Requirement    | Status       | Test Evidence          | Notes                               |
| -------------- | ------------ | ---------------------- | ----------------------------------- |
| API Contract   | ✅ COMPLIANT | `test_api_contract.py` | All endpoints implemented correctly |
| Data Models    | ✅ COMPLIANT | `test_models.py`       | Models match spec                   |
| Error Handling | ⚠️ PARTIAL   | `test_errors.py`       | One error case not handled per spec |
| Performance    | ✅ COMPLIANT | `test_perf.py`         | Meets performance requirements      |

## 4. Identified Issues

### 4.1 Critical Issues (Blocking)

- **Issue 1:** [Description of critical issue]
  - **Location:** `path/to/file.py:line_number`
  - **Impact:** [Describe impact]
  - **Test Case:** `test_name`
  - **Recommendation:** [Suggest fix]

### 4.2 Non-Critical Issues (Non-Blocking)

- **Issue 1:** [Description of non-critical issue]
  - **Location:** `path/to/file.py:line_number`
  - **Impact:** [Describe impact]
  - **Test Case:** `test_name`
  - **Recommendation:** [Suggest fix]

## 5. Test Enhancements Added

- [List any new tests written by QA to fill coverage gaps, or mention
  improvements in existing test structure]

## 6. Environment and Configuration

- **Test Environment:** [Local / CI / Test Environment]
- **Software Versions:** [Relevant frameworks, libraries, etc.]
- **Configuration:** [Any special configuration used for testing]

## 7. Conclusion

[Overall assessment of the implementation quality based on testing. Should this
pass the QA gate? Are any urgent fixes required?]

## 8. Attachments

- [Test logs, screenshots, or performance benchmarks if relevant]
