Skip to content

pull_request_template.md

Latest commit

 

History

History
74 lines (53 loc) · 2.22 KB

pull_request_template.md

File metadata and controls

74 lines (53 loc) · 2.22 KB
Raw

What changed

Related issue: Closes #

How it was verified

$ cargo test -p dataprof-core
test result: ok. 156 passed; 0 failed
Commands by area (expand for the usual ones)

Rust — CI pins Rust 1.98, so prefer cargo +1.98 when your local toolchain differs:

cargo test -p <crate-you-changed>
cargo fmt --all
cargo clippy --all --all-targets -- -D warnings

Python:

uv run maturin develop
uv run pytest python/tests/<file-you-changed>.py -q
uv run ruff format python/ .github/scripts/ .claude/skills/dataprof/scripts/
uv run ruff check python/ .github/scripts/ .claude/skills/dataprof/scripts/
uv run ty check python/

Docs or examples — build the examples you touched; CI runs them:

cargo run --example <example-you-changed>

Serialized report schema — only if you changed a ProfileReport field or its Serde attributes. See the report schema release checklist:

cargo run --example generate_profile_schema
cargo test --test profile_report_schema

Anything reviewers should know

  • Breaking change: what breaks, and what a user does instead.
  • Feature flags: which flags gate this, and what happens without them.
  • Generated schema: the regenerated artifact is included in this PR.

New here? docs/CONTRIBUTING.md covers setup and the review process, and AGENTS.md is the condensed version of the same conventions.