Skip to content

PULL REQUEST TEMPLATE

Description

  • Fixes #(issue number)

Checklist

  • My code follows the contributing guidelines of this project, including, in particular, with regard to any style guidelines
  • The title of my PR complies with the Conventional Commits specification; in particular, it clearly indicates that a change is a breaking change
  • I acknowledge that all my commits will be squashed into a single commit, using the PR title as the commit message
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have updated the user-facing documentation to describe any new or changed behavior
  • I have added type annotations for all function/class/method interfaces or updated existing ones (only for Python, TypeScript, etc.)
  • I have provided appropriate documentation (Google-style Python docstrings or JSDoc block tags ) for all packages/modules/functions/classes/methods or updated existing ones
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have not reduced the existing code coverage

Comments