Skills Development Structured Bug Reports for Database Migration

Structured Bug Reports for Database Migration

v20260410
creating-oracle-to-postgres-migration-bug-report
This guide outlines the process and mandatory structure for documenting defects found during an Oracle-to-PostgreSQL migration. It details how to write actionable bug reports, covering required elements like Severity, Root Cause, Scenario, and Solution. It emphasizes treating Oracle as the source of truth and handling data layer nuances (e.g., NULL vs. empty string) to ensure accurate defect tracking and remediation.
Get Skill
80 downloads
Overview

Creating Bug Reports for Oracle-to-PostgreSQL Migration

When to Use

  • Documenting a defect caused by behavioral differences between Oracle and PostgreSQL
  • Writing or reviewing a bug report for an Oracle-to-PostgreSQL migration project

Bug Report Format

Use the template in references/BUG-REPORT-TEMPLATE.md. Each report must include:

  • Status: ✅ RESOLVED, ⛔ UNRESOLVED, or ⏳ IN PROGRESS
  • Component: Affected endpoint, repository, or stored procedure
  • Test: Related automated test names
  • Severity: Low / Medium / High / Critical — based on impact scope
  • Problem: Expected Oracle behavior vs. observed PostgreSQL behavior
  • Scenario: Ordered reproduction steps with seed data, operation, expected result, and actual result
  • Root Cause: The specific Oracle/PostgreSQL behavioral difference causing the defect
  • Solution: Changes made or required, with explicit file paths
  • Validation: Steps to confirm the fix on both databases

Oracle-to-PostgreSQL Guidance

  • Oracle is the source of truth — frame expected behavior from the Oracle baseline
  • Call out data layer nuances explicitly: empty string vs. NULL, type coercion strictness, collation, sequence values, time zones, padding, constraints
  • Client code changes should be avoided unless required for correct behavior; when proposed, document and justify them clearly

Writing Style

  • Plain language, short sentences, clear next actions
  • Present or past tense consistently
  • Bullets and numbered lists for steps and validations
  • Minimal SQL excerpts and logs as evidence; omit sensitive data and keep snippets reproducible
  • Stick to existing runtime/language versions; avoid speculative fixes

Filename Convention

Save bug reports as BUG_REPORT_<DescriptiveSlug>.md where <DescriptiveSlug> is a short PascalCase identifier (e.g., EmptyStringNullHandling, RefCursorUnwrapFailure).

Info
Category Development
Name creating-oracle-to-postgres-migration-bug-report
Version v20260410
Size 2.79KB
Updated At 2026-04-12
Language