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

Update wiki for changes in 3.0.0 #1917

Closed
jrfnl opened this issue Jul 6, 2020 · 5 comments
Closed

Update wiki for changes in 3.0.0 #1917

jrfnl opened this issue Jul 6, 2020 · 5 comments

Comments

@jrfnl
Copy link
Member

jrfnl commented Jul 6, 2020

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
Copy link
Member Author

jrfnl commented Jun 24, 2022

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

  • Running in Travis - the workflow will need to be changed to not clone the repos, but use a Composer install.
  • 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+.
  • Customizable sniff properties - the names of custom properties which have been renamed/changed/added will need to be updated.
  • whitelist code that is being flagged with errors - page probably should be removed (or rewritten)
  • 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....

@dingo-d
Copy link
Member

dingo-d commented Jun 27, 2022

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 🤷🏼‍♂️

@jrfnl
Copy link
Member Author

jrfnl commented Jun 27, 2022

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 jrfnl changed the title Update terminology used in the wiki Update wiki for changes in 3.0.0 Mar 18, 2023
@jrfnl
Copy link
Member Author

jrfnl commented Aug 20, 2023

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

New pages to be added:

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

@jrfnl jrfnl mentioned this issue Aug 20, 2023
36 tasks
@jrfnl
Copy link
Member Author

jrfnl commented Aug 21, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants