Skip to content

V1 [INFRA] Pull request template #67

Description

@austin-barrington

Context

There is no .github/PULL_REQUEST_TEMPLATE.md. PR descriptions vary in quality. Reviewers must chase authors for basic information (test evidence, docs updates, changelog entry).

Deliverables

Create .github/PULL_REQUEST_TEMPLATE.md with sections:

  • Description — what this PR does and why
  • Checklist (checkbox list):
    • cargo fmt --all --check passes
    • cargo clippy --all-targets -- -D warnings passes
    • cargo test --lib passes
    • cargo test --test * passes
    • New features have documentation (user-guide or developer-guide)
    • New config keys have entries in docs/user-guide/configuration.md and config.toml.example
    • New metrics follow the naming convention (hyperbytedb_*)
    • Breaking changes are noted in the PR description
  • Related issuesCloses #... or Refs #...
  • Release notes — short summary for CHANGELOG

Priority

P1 — Developer workflow

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status
    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions