PULL_REQUEST_TEMPLATE.md

June 25, 2026 ยท View on GitHub

Summary

Describe what this PR changes and why.

Link the related issue if available.

Example: Closes #123

Type of Change

  • Bug fix
  • New feature
  • Refactor
  • Documentation update
  • CLI behavior change

What Changed

List the key changes in a few bullets.

Validation

Describe how you validated this change.

CLI smoke check

oracletrace --help

Functional trace run

oracletrace your_script.py

JSON export and compare flow

oracletrace your_script.py --json baseline.json
oracletrace your_script.py --json current.json --compare baseline.json

CSV, ignore, and top flags

oracletrace your_script.py --csv trace.csv
oracletrace your_script.py --ignore ".*helper_function.*" "debug_.*"
oracletrace your_script.py --top 10

Docs build (if docs changed)

mkdocs build -f docs/mkdocs.yml

Checklist

  • The code follows style conventions.
  • I added unit tests for the new functionality.
  • CI (GitHub Actions) is green.
  • I updated documentation/README when needed.

Before/After Output (if applicable)

Include relevant CLI output snippets when behavior or formatting changed.

Before

After

Additional Notes

Anything reviewers should pay special attention to.