Skip to main content
Use this checklist to confirm that a pull request has a clear scope, correct contracts, reproducible evidence, and a reviewable final diff. This page keeps only merge gates shared by all pull requests. Follow the linked guides for implementation rules, test commands, and documentation conventions. Complete only the applicable items; when a skipped check affects risk assessment, explain the reason and impact in the pull request.

Scope and Review Context

  • The pull request solves one focused problem, and the final diff excludes unrelated refactors, formatting, dependency upgrades, or generated output.
  • The description explains the problem, owning component, important design decisions, user-visible behavior before and after the change, and excluded scope.
  • The branch includes the latest commit from the target branch, and dependent pull requests, stack relationships, and merge order are linked and explained.
Follow the general contribution workflow for branch, commit, and pull request description conventions.

Contracts, Compatibility, and Safety

  • Each affected Benchmark, Harness, Environment, Recipe, or Analyzer satisfies the completion gate in its integration guide.
  • When public configuration, supported combinations, persisted structures, or lifecycle behavior change, compatibility, migration, error classification, and resource cleanup are handled in proportion to risk, with known limitations stated.
  • The diff exposes no credentials, personal data, or internal infrastructure; weakens no security boundary enforced by an Environment; and includes no datasets, Model outputs, complete result directories, caches, or other large generated artifacts.
Use the completion gates for Benchmark, Harness, Environment, Recipe, and Analyzer integrations.

Validation and Reproducible Evidence

  • Focused checks appropriate to the changed surface have run, and the full pre-commit command used by current CI passes before review.
  • Component discovery, generated or merged configuration, and at least one representative real task have been verified where applicable.
  • Relevant failure paths are checked, and the precedence of explicit settings over defaults, retry and timeout behavior, cancellation, compatibility, and cleanup are verified in proportion to risk.
  • The pull request records exact sanitized commands, relevant versions and configuration, important outcomes, and a concrete reason and risk for checks not run.
Follow Testing and Validation for the current repository checks, commands, and evidence format.

Documentation and Final Diff

  • When public behavior changes, the corresponding documentation is updated in the same pull request with complete English and Chinese content.
  • When pages are added, moved, or removed, both locale trees, docs/docs.json, incoming links, and required redirects are updated.
  • Documentation changes pass mint broken-links and mint validate; changes to navigation, tables, components, or responsive layout are also previewed.
  • The final diff contains no merge markers, accidental formatting churn, debug output, stale comments, or unrelated changes, and the implementation, documentation, and evidence describe the same behavior.
Follow Documentation Contributions for placement, localization, navigation, public-content boundaries, and Mintlify rules.