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

Update terminology used in the wiki

Open jrfnl opened this issue 5 years ago • 3 comments

As discussed in #1908, the wiki pages should be reviewed and references to "whitelisting" code should be replaced with other phrasing, such as "ignoring code"

The wiki should also be updated to reflect that support for the old-style WPCS native ignore comments has been removed in WPCS 3.0.0.

jrfnl avatar Jul 06 '20 15:07 jrfnl

List of things which will need updating in the wiki before the 3.0.0 release:

  • [x] Running in Travis - the workflow will need to be changed to not clone the repos, but use a Composer install.
  • [x] Customizable sniff properties - references to removed sniffs should be moved to the bottom with a note that those sniffs are no longer available in WPCS 3.0+.
  • [x] Customizable sniff properties - the names of custom properties which have been renamed/changed/added will need to be updated.
  • [x] whitelist code that is being flagged with errors - page probably should be removed (or rewritten)
  • [x] Update references to the project from WPCSto WordPressCS (and if that changes URLs, make sure links to those wiki pages in the README and such get updated too).

Note: this list may not be complete....

jrfnl avatar Jun 24 '22 16:06 jrfnl

Running in Travis - the workflow will need to be changed to not clone the repos, but use a Composer install.

We will leave this for legacy reasons? Since we're not running checks in TravisCI any more 🤷🏼‍♂️

dingo-d avatar Jun 27 '22 06:06 dingo-d

We will leave this for legacy reasons? Since we're not running checks in TravisCI any more 🤷🏼‍♂️

This is not about our CI, but an example for projects using WPCS. There may still be (mostly commercial plugins/themes) running their CI on Travis, so for them, it's good to have an example for how to set it up.

jrfnl avatar Jun 27 '22 06:06 jrfnl

Wiki pages review list - those pages marked with a ✔️ have been updated for WordPressCS 3.0.0:

New pages to be added:

  • [x] Upgrade guide to WordPressCS 3.0.0 for end-users/ruleset maintainers.
  • [x] Upgrade guide to WordPressCS 3.0.0 for Developers of external standards.

jrfnl avatar Aug 20 '23 03:08 jrfnl

All pages have received a cursory review and been update. Further, more detailed review is welcome, but not essential for the WPCS 3.0.0 release.

Closing this issue now as fixed.

jrfnl avatar Aug 21 '23 06:08 jrfnl