-
Notifications
You must be signed in to change notification settings - Fork 62
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
Plugin Review Team: Ensure top level of "Error" includes no false positives. #440
Comments
@bordoni @barrykooij Curious to learn more about this, can you provide a bit more context on what this is about? How could we possibly ensure there are no false positives? Maybe I'm misunderstanding the issue description. |
@felixarntz This issue is about identifying what phpcs rules are 100% blocking for new submission. These should not have any false positives. An example of a 100% blocking check is |
@barrykooij Thanks, makes sense! Is the idea to put those rules into a new PHPCS config once they're identified? Or a new check group? How would those rules technically be annotated / grouped so that only those would run in the new submission process? |
@felixarntz I'm not sure yet, whatever works best. I'm currently leaning towards creating a set (check group?) of "blocking" PHPCS rules and if any of these fails, a submission is blocked. Another thing we need to in mind is that we're going to expand the checks to other form of checks than PHPCS, like a readme parser. I think it would be good to also show this in the "regular" PCP wp-admin result, so a developer can see that the current version of the plugin contains blocking issues. I'm currently creating a meta trac ticket to discuss how to run only these checks in a new plugin submission. Related to this is also #441 |
In that case a "check category" probably makes most sense. For instance, we could add a "Plugin Submission" or "Plugin Repo (blocking)" category to https://github.com/WordPress/plugin-check/blob/trunk/includes/Checker/Check_Categories.php#L48 and assign the relevant checks to that category. |
Alright. I've created a list of checks and PHPCS rules that I think should be included in the first version. Checks
PHPCS RULES
I'm still in doubt about
The only thing I'm not happy about in this solution is that we don't want to have this be a publicly new check category. Ideally, I see this included in the _ Plugin Repo_ category, perhaps as a new Type of check result. Now Error is the highest find type, maybe we can introduce a level above this like Blocking. This way we can make it clear to people using the plugin that the submission will be blocked in the current state. |
One way we could address this problem is by implementing a "severity" system, as discussed in #479. With that in place, we could set some guidelines for what would cause a check to meet different severity levels and make sure all blocking checks are configured with a severity level above a certain threshold (e.g. 8). WP VIP has a page dedicated to interpreting severity levels for their WordPress-VIP-Go sniffs that could be referenced for inspiration. |
So, in somewhere we should cover all severity levels for all checks. I'd suggest to make it in the documentation area. |
Closed as it was merged severity PR |
As we talked last week @barrykooij will own this task to making sure that we have either:
That is important to enables us to have it be part of the submission on WordPress.org, which should enable us to reduce the Queue and maintain it at a good level.
Currently there is no way to appeal specific items that might be a false positive so this is a must.
The text was updated successfully, but these errors were encountered: