jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-04-28 07:17:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
developers.home-assistant/docs/development_checklist.md
Jesse Johnson e4f52191d1
Update development checklist to include formatting code with Ruff (#2217) 
Updates the development checklist to match the current PR template, which suggests using Ruff for code formatting as it has replaced Black. (Indeed, Black is no longer available in the Home Assistant virtual environment.)
2024-06-14 22:16:07 +02:00

1.6 KiB
Raw Blame History

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.
    • Issue trackers must be enabled for external Python libraries that has communication with external devices or services.
    • If the library is mainly used for Home Assistant and you are a code owner of the integration it is encouraged to use an issue template picker with links to Home Assistant Core Issues. For example: zwave-js-server-python - New Issue
  • 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 provides a fully type hinted source.
  • The code is formatted using Ruff (ruff format).
  • Documentation is developed for home-assistant.io