PR Instructions/requirements

  • Title uses type: description format. See CONTRIBUTING.md for types.
    • Common types are: build, docs, feat, fix, refactor, revert, test
    • Update CHANGELOG.md as applicable
  • Breaking changes include “!” after the type and a “BREAKING CHANGES:” section at the bottom. See CONTRIBUTING.md for our breaking changes process.
  • Body text describes:
    • Why this change is being made, briefly.
    • Before and after behavior, as applicable
    • References issue number, as applicable
  • Update docs and tests, as applicable
  • Delete these instructions prior to sending the PR