Curated list of awesome Home Assistant resources. https://www.awesome-ha.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

58 lines
2.1 KiB

  1. # Contribution Guidelines
  2. Your contributions are always welcome! Thank you for your suggestions! :smiley:
  3. Please note that this project is released with a
  4. [Contributor Code of Conduct](https://github.com/frenck/awesome-home-assistant/blob/master/CODE_OF_CONDUCT.md).
  5. By participating in this project you agree to abide by its terms.
  6. Contributing is pretty easy, all you need is an GitHub account.
  7. [Just click this link to edit the list, right from your browser](https://github.com/frenck/awesome-home-assistant/edit/master/README.md).
  8. ## Guidelines
  9. ### Link requirements
  10. The site the link targets **MUST BE**:
  11. - Be widely recommended regardless of personal opinion.
  12. - Well known or discussed within the Community.
  13. - Related to Home Assistant OR provide software, tools, and utilities
  14. that can be used with Home Assistant.
  15. - Written in English.
  16. Self-promotion is frowned upon, so please consider seriously whether your
  17. project meets the criteria before opening a pull request, otherwise, it may
  18. be closed without being reviewed.
  19. ### Adding a new link
  20. - **Make an individual pull request for each link suggestion.**
  21. - Search previous suggestions before making a new one, as yours may be a duplicate.
  22. - Use the following format: `- [project-name](http://example.com/) - A short description ends with a period.`
  23. - Keep the description short and simple, but descriptive.
  24. - A description ends with a full stop/period `.`!
  25. - Don't mention `Home Assistant` in the description as it's implied.
  26. - Check your spelling and grammar.
  27. - Make sure that your suggestion is positioned as the last item category.
  28. ### Adding a new section/category
  29. New categories or improvements to the existing categorization are welcome.
  30. - Ensure the section has a nice description.
  31. - A description ends with a full stop/period `.`!
  32. - Add the section to the table of contents.
  33. - Check your spelling and grammar.
  34. - Remove any trailing whitespace.
  35. ### Deleting a link
  36. Typical reasons for deleting links:
  37. - The item does no longer apply to or work with the latest Home Assistant.
  38. - No updates / abandoned.
  39. - Deprecated.
  40. - In case of software: License missing.
  41. - Dead link.