Skip to content

Commit

Permalink
HOUSEKEEPING: pre-commit configuration, PR template update
Browse files Browse the repository at this point in the history
Add pre-commit configuration
Add formatting requests in README.md and PR template

Signed-off-by: Joe Block <jpb@unixorn.net>
  • Loading branch information
unixorn committed Nov 25, 2023
1 parent 1e773aa commit 337c8bb
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/new_entry.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
--
name: New Entry Submission
about: Suggest an entry for the list
title: "[NEW ENTRY]"
Expand All @@ -11,14 +11,14 @@ assignees: ''

Name and shame time. Please include a link to the product/service.

## Why is it bad?
## Why is it trash?

Please detail why it shouldn't be used. Possible issues include but are definitely not limited to:
Please detail what earned it its trash status. Possible issues include but are definitely not limited to:

- A product that previously had API access has been locked down to require you to use the vendor's crapware
- A product that previously had a free API to control your devices is switching to paid subscription
- A product that used to work in a local-only mode is being "upgraded" to require a cloud service or account to function
- An API that was usable to provide integrations to projects like Home Assistant and Hubitat has been disabled or removed
- An API that was usable to provide integrations to projects like [Home Assistant](https://home-assistant.io) and [Hubitat](https://hubitat.com) has been disabled or removed
- Safety issues
- Security issues.
- Vendor has been actively hostile to developers using their API. Mazda sending a cease and desist letter to the Mazda integration author, for example.
Expand All @@ -29,4 +29,4 @@ If there are articles / blog posts / press releases describing why it's bad, ple

If there's a workaround (like attaching Hue bulbs to a non-Philips zigbee controller), include that here. If there are other products that can replace it, please include links. In the interest of keeping entries short, we prioritize links to products like opengarage.io that publish their firmware, especially if it has an open source license.

Finally, thanks for the help - the IOT ecosystem gets larger every day and one person can't keep up on everything.
Finally, thanks for the help - the IOT ecosystem gets larger every day and one person can't keep up on everything.
14 changes: 14 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: check-added-large-files
- id: check-executables-have-shebangs
- id: check-merge-conflict
- id: check-shebang-scripts-are-executable
- id: check-symlinks
- id: end-of-file-fixer
- id: trailing-whitespace
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ Some of the reasons things get listed here:

## Hall of Shame

<!--
Please keep entries to single lines - it makes sorting them much easier
Please add new entries in alphabetical order - it will make things easier to find when the list gets larger
-->

| Device | Reason it's garbage | Date | Workarounds if any |
| -------------------------------------------- | ------------------- | ---------- | ----------- |
| Chamberlain MyQ Smart Garage Door Controller | Chamberlain shut off all access to its APIs.<br>See <ul><li>Chamberlain's [Press Release](https://chamberlaingroup.com/press/a-message-about-our-decision-to-prevent-unauthorized-usage-of-myq)</li><li>The Verge's [coverage](https://www.theverge.com/23949612/chamberlain-myq-smart-garage-door-controller-homebridge-integrations)</li></ul> | 2023-11-07 | Replace with a better solution:<ul><li>[opengarage.io](https://opengarage.io) - Their hardware design and software code (including both firmware and app code) and API documents are publicly available in the [OpenGarage github repository](https://github.com/OpenGarage)</li><li>[ratgdo](https://paulwieland.github.io/ratgdo/) is another solution with open source firmware that works with Security+ 2.0 openers.</li></ul> |
Expand Down

0 comments on commit 337c8bb

Please sign in to comment.