Skip to content

Latest commit

 

History

History
36 lines (29 loc) · 1.51 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

36 lines (29 loc) · 1.51 KB
Raw

Description

Checklist

  • Docstrings for all functions
  • Gallery example in ./doc/examples (new features only)
  • Benchmark in ./benchmarks, if your changes aren't covered by an existing benchmark
  • Unit tests
  • Clean style in the spirit of PEP8
  • Descriptive commit messages (see below)

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in doc/release/release_dev.rst.
  • There is a bot to help automate backporting a PR to an older branch. For example, to backport to v0.19.x after merging, add the following in a PR comment: @meeseeksdev backport to v0.19.x
  • To run benchmarks on a PR, add the run-benchmark label. To rerun, the label can be removed and then added again. The benchmark output can be checked in the "Actions" tab.