I recently published two Home Assistant projects and would appreciate some feedback from the community to make sure I followed the recommended practices for HACS and Home Assistant development.
The first project is a custom integration, while the second is a Lovelace card.
This is my first time publishing projects intended for use through HACS, so I would like to know:
Is the repository structure correct?
Are there any HACS requirements or best practices that I may have missed?
Is the documentation sufficient and clear enough?
Are the releases, versioning, and manifests properly configured?
Are there any Home Assistant quality standards that I should consider before promoting these projects more broadly?
I am not looking for a full code review, but rather confirmation that I am on the right track and suggestions for improvements from experienced Home Assistant developers.
I had a quick look at the integration. I am not familiar with cards.
Structure seems correct.
Only thing I noticed is that all your brands images are the same. You can leave out all except for the "icons" files and it should still work (I assume the missing images handling descibed for brands repo also works for local brands images)
There is also a brands folder on top level in the repo which seems like a leftover.
Not a requirement, but you can do zip releases with HACS. If you do that then the download numbers will show up in the HACS panel which might be interesting. Note that these numbers are per release so they will reset on each release.
btw the HA version in the hacs.json is rather old (2024.6.0). Do you really test against that? If not just bump it to a more recent version.
I can't judge the documentation, my French is basically non-existing.
Releases and versions seem fine.
For Home Assistant quality standards you can have a look at the quality scale description and the explanation of the quality rules.
I would not consider qualityscale needed before promoting it broader. If what you have is working fine, just go for it and get some feedback.
You might want to consider adding automated tests at some point. Take a look at pytest-homeassistant-custom-component to help with that. It allows you to use the same test fixtures as Home Assistant uses in a custom_component.