developers.home-assistant/docs/development_checklist.md

1.3 KiB

title sidebar_label
Development Checklist Introduction

Before you commit any changes, check your work against these requirements:

  • All communication to external devices or services must be wrapped in an external Python library hosted on pypi.
  • New dependencies are added to requirements_all.txt (if applicable), using python3 -m script.gen_requirements_all
  • New codeowners are added to CODEOWNERS (if applicable), using python3 -m script.hassfest
  • The .coveragerc file is updated to exclude your platform if there are no tests available or your new code uses a third-party library for communication with the device, service, or sensor. config_flow.py can't be excluded as it must be fully tested (100% coverage).
  • The .strict-typing file is updated to include your code if it does provide a fully type hinted source.
  • The code is formatted using Black, as per these guidelines. This can be done running the command black --fast homeassistant tests.
  • Documentation is developed for home-assistant.io