hacf-fr / homeassistant-guide-du-developpeur

💻 Un guide en français pour contribuer au projet Home Assistant

Home Assistant - Guide du développeur

• La boîte à outils
• Participer aux projets
• Les environnements (Le backend et le frontend)
• Préparer son environnement
• Les ressources

Présentation

Ce guide a pour vocation de présenter le développement de composants de Home Assistant.

Pour ce faire nous présenterons indépendamment chacun des environnements de développement :

• le backend qui concerne les intégrations (entités/sensors)

• le frontend qui concerne l'interface utilisateur (Lovelace et ses composants)

La boîte à outils

Chaque environnement a ses outils spécifiques et seront précisés dans chaque section.

Néanmoins voici quelques éléments communs aux deux :

Obligatoires:

• git pour la gestion de version.
• Un compte Github

Recommandés:

• Docker pour tester vos contributions dans un environement local et dédié (conteneur).
• Visual Studio Code (VSC). Tout autre editeur peut convenir. VSC offre plusieurs addons qui facilitent le développemnent avec Home Assistant.
• L'Addon Remote - Containers pour VSC. Il permet d'utiliser les conteneurs de développement via Docker.

Participer aux projets

Avant de présenter plus en avant le développement sous Home Assistant, nous allons faire un point sur la gestion d'un projet (un développement).

Si vous êtes familier avec GitHub, vous pouvez passer ce chapitre. Pour les autres ...

• Travailler avec GitHub

Les environnements

Il y a deux environnements distincts :

• Le backend ou le coeur de Home Assistant
• Le frontend ou l'interface utilisateur

Suivant ce que vous allez travailler, vous n'aurez pas besoin des mêmes langages, compétences et ressources.

• Développer en backend

• Développer en frontend

Les ressources

Ci-dessous un ensemble de ressources qui compléteront votre apprentissage.

• La documentation développeur chez Home Assistant
• La gestion des flux, des Issues et des Pull Request (PR) de Github
• Le template prêt à l'emploi CookieCutter
• Les icônes incontournables de Material Design

homeassistant-guide-du-developpeur's Issues

Faire unen référence aux problèmes potentiel de perfo avec devcontainer.

Element pour solutions: https://code.visualstudio.com/docs/remote/containers-advanced#_improving-container-disk-performance

Guide git en français

https://rogerdudler.github.io/git-guide/index.fr.html

La table des matières ne fonctionne pas

Ajouter lien vers la référence du code.

http://dev-docs.home-assistant.io/

Détailler les lignes de commande à exécuter

Serait-il possible d’étoffer la documentation en ajoutant les ligne de commande Git permettant de faire un Fork, ..., Pull Request ?

Je prend comme exemple mon cas.
J’ai essayé de modifier la awesomelist via mon fork de la awesomelist directement depuis mon Github (Web). Et ça n’a pas bien fonctionné…
Si vous avez de la doc et la manière « propre » que vous utilisez, je veux bien ajouter ces infos en utilisant cette méthode au fichier Github.md du repository.

Renommer le dépôt en 'homeassistant-guide-developpeur'

Je n'ai pas la main pour faire cela.

backend et custom component

Est -ce que l'on fait une section spécial pour les custom component ? Ou est ce que l'on inclus dans la partie backend (sous entendu HA core) ?

Plusieurs liens morts

Plusieurs liens renvoient des 404