Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

homebridge-winix-purifiers #648

Closed
bcullman opened this issue Dec 15, 2023 · 14 comments
Closed

homebridge-winix-purifiers #648

bcullman opened this issue Dec 15, 2023 · 14 comments
Labels
verified use when a plugin meets the criteria - adds the verified badge text

Comments

@bcullman
Copy link

bcullman commented Dec 15, 2023

Link To GitHub Repo

https://github.com/regaw-leinad/homebridge-winix-purifiers

Link To NPM Package

https://www.npmjs.com/package/homebridge-winix-purifiers

Plugin Icon (Optional)

@bcullman bcullman added the pending the label given to a new verification/icon request label Dec 15, 2023
Copy link

The following pre-checks failed:

❌ Could not determine plugin name.

Comment /check to run checks again.

@bcullman
Copy link
Author

/check

Copy link

The following pre-checks failed:

❌ Could not determine plugin name.

Comment /check to run checks again.

@bwp91
Copy link
Contributor

bwp91 commented Dec 16, 2023

Hi @bcullman

Just looking now to see why there are issues with the plugin name.

We would also normally want/expect the developer of a plugin to request verification.

Are they aware? In agreement?

@bwp91
Copy link
Contributor

bwp91 commented Dec 16, 2023

/check

Copy link

The following pre-checks failed:

❌ Could not determine plugin name.

Comment /check to run checks again.

@bwp91
Copy link
Contributor

bwp91 commented Dec 16, 2023

/check

Copy link

✅ Pre-checks completed successfully.

@bcullman
Copy link
Author

Hi @bcullman

Just looking now to see why there are issues with the plugin name.

We would also normally want/expect the developer of a plugin to request verification.

Are they aware? In agreement?

hi @bwp91 -

This is my bad. I have not checked with the author, @regaw-leinad, I am simply an enthusiastic user of the plugin. I did take a moment to review the verification process, and it sorta seemed like this plugin would have passed straight out. When it didn't, I should have closed the PR, but I got distracted.

it does seem the pre-check is passing now. I will proceed however you choose.

@regaw-leinad
Copy link

Hi @bcullman and @bwp91 - im only just now seeing this - currently traveling. I appreciate you posting this here for verification. I remember I hadn't taken this step yet due to something i felt was missing from the requirements, but I can't quite remember off the top of my head (and while on mobile). I'll sit down and take a look when I get settled.

I'm on board for this as long as it's passing the requirements.

@bwp91 bwp91 added currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes and removed pending the label given to a new verification/icon request labels Dec 27, 2023
Copy link

github-actions bot commented Dec 27, 2023

  • General
    • The plugin must be of type dynamic platform.
    • The plugin must not offer the same nor less functionality than that of any existing verified plugin.
  • Repo
    • The plugin must be published to NPM and the source code available on a GitHub repository, with issues enabled.
    • A GitHub release should be created for every new version of your plugin, with release notes.
  • Environment
    • The plugin must run on all supported LTS versions of Node.js, at the time of writing this is Node v18 and v20.
    • The plugin must successfully install and not start unless it is configured.
    • The plugin must not execute post-install scripts that modify the users' system in any way.
    • The plugin must not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.
  • Codebase
    • The plugin must implement the Homebridge Plugin Settings GUI.
    • The plugin must not contain any analytics or calls that enable you to track the user.
    • If the plugin needs to write files to disk (cache, keys, etc.), it must store them inside the Homebridge storage directory.
    • The plugin must not throw unhandled exceptions, the plugin must catch and log its own errors.



Comment /check to run checks again.

@bwp91
Copy link
Contributor

bwp91 commented Dec 27, 2023

I'm happy to mark this plugin as verified. There are a couple of items that are technically not satisfied:

The plugin must be of type dynamic platform.

This was a new rule that I implemented to push new developers to creating platform-based plugins. Since this is an established plugin already, happy to waive the rule.

A GitHub release should be created for every new version of your plugin, with release notes.

Please do this in the future! The Homebridge UI displays release notes when a user updates the plugin, and these are pulled from GitHub, so this is the reasoning for this requirement.

@regaw-leinad if you have any questions about this please feel free to reach out 😀

@bwp91 bwp91 added verified use when a plugin meets the criteria - adds the verified badge text and removed currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes labels Dec 27, 2023
Copy link

Congratulations! Your plugin has been verified.

You can now add one of the Verified by Homebridge badges to your plugin's README:

verified-by-homebridge

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

verified-by-homebridge

[![verified-by-homebridge](https://img.shields.io/badge/homebridge-verified-blueviolet?color=%23491F59&style=for-the-badge&logoColor=%23FFFFFF&logo=homebridge)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

Your plugin is now also eligible to display a ❤️ Donate button on its tile in the Homebridge UI. See https://github.com/homebridge/homebridge/wiki/Donation-Links for instructions.

If for any reason in the future you can no longer maintain your plugin, please consider transferring it to our unmaintained plugins repo. We can take ownership until another willing developer comes along.

Don't forget to join the official Homebridge Discord server, where plugin developers can get tips and advice from other developers and the Homebridge project team in the #plugin-development channel!

Thank you for your contribution to the Homebridge Community.
https://homebridge.io

@bwp91 bwp91 closed this as completed Dec 27, 2023
@regaw-leinad
Copy link

regaw-leinad commented Dec 28, 2023

Hey, thanks for this! I just arrived back home and looking into this now

The plugin must be of type dynamic platform.

This was a new rule that I implemented to push new developers to creating platform-based plugins. Since this is an established plugin already, happy to waive the rule.

I do now remember this being the reason I didn't push to verify - I hadn't converted this over to a dynamic plugin. I'll look into this moving forward.

A GitHub release should be created for every new version of your plugin, with release notes.

Please do this in the future! The Homebridge UI displays release notes when a user updates the plugin, and these are pulled from GitHub, so this is the reasoning for this requirement.

Will do!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
verified use when a plugin meets the criteria - adds the verified badge text
Projects
None yet
Development

No branches or pull requests

3 participants