WordPress-Coding-Standards icon indicating copy to clipboard operation
WordPress-Coding-Standards copied to clipboard

Add note to README explaining that `WordPress` includes sniffs beyond the subsets.

Open leewillis77 opened this issue 1 month ago • 6 comments

Adds a small explanation that running WordPress is not the same as running WordPress-Core,WordPress-Docs,WordPress-Extra as noted in https://github.com/WordPress/WordPress-Coding-Standards/issues/1440

leewillis77 avatar Nov 26 '25 10:11 leewillis77

Thanks @leewillis77, that looks like a valid addition.

I wonder whether people will raise the question "what is the difference" and whether it would make sense to answer that here.... Opinions ?

jrfnl avatar Nov 26 '25 10:11 jrfnl

I wonder whether people will raise the question "what is the difference" and whether it would make sense to answer that here.... Opinions ?

There's no documentation on what sniffs are included in which standard as-is so I don't think this is necessary, but I guess it may be useful, maybe just link the text to https://github.com/WordPress/WordPress-Coding-Standards/tree/develop/WordPress/Sniffs ?

leewillis77 avatar Nov 26 '25 10:11 leewillis77

I'm not sure if that is what @jrfnl had in mind, but from my perspective, including in the note which sniffs are part of the WordPress standard and are not part of any of the subsets would be enough to answer the questions of what the difference is. What do you think?

rodrigoprimo avatar Nov 26 '25 12:11 rodrigoprimo

I'm not sure if that is what @jrfnl had in mind, but from my perspective, including in the note which sniffs are part of the WordPress standard and are not part of any of the subsets would be enough to answer the questions of what the difference is. What do you think?

My personal perspective is that it's too detailed for that document, but happy to add it into the PR if that's requested.

leewillis77 avatar Nov 26 '25 12:11 leewillis77

If we were going to add the information I'd suggest a footnote something like this:

https://github.com/leewillis77/WordPress-Coding-Standards/tree/footnote-for-wp-standard-checks?tab=readme-ov-file#rulesets

Let me know if you would like me to update the PR to include this change.

leewillis77 avatar Nov 26 '25 13:11 leewillis77

Marking this PR as BLOCKED for the time being until the revived discussion in #1440 has been resolved.

Also see: https://github.com/WordPress/WordPress-Coding-Standards/issues/1440#issuecomment-3583648158

jrfnl avatar Nov 27 '25 00:11 jrfnl