-
-
Notifications
You must be signed in to change notification settings - Fork 493
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 documentation (README, CONTRIBUTING) for release of WordPressCS 3.0.0 #2367
Merged
dingo-d
merged 3 commits into
develop
from
feature/docs-update-readme-contributing-et-al-3.0.0
Aug 20, 2023
Merged
Update documentation (README, CONTRIBUTING) for release of WordPressCS 3.0.0 #2367
dingo-d
merged 3 commits into
develop
from
feature/docs-update-readme-contributing-et-al-3.0.0
Aug 20, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit updates the README guide to be in line with WordPressCS 3.0.0. This commit: * Removes the "Last commit to stable" and "Nr of contributors" badges. * Updates the "Tested on PHP..." badges. * Updates the table of contents to match the new content of the file. * Removes the "Project history" section (has been moved to the wiki). * Makes the pre-requisites for the package more explicit and puts them in a separate section. * Updates the installation instructions and adds update instructions. - Removes the instructions related to stand-alone installs and using `composer create-project`. - The new installation instructions take the changes in Composer 2.2 (permission required for plugins to run) into account. - The new installation instructions include a link to the end user/ruleset maintainer upgrade guide for WPCS 3.0.0 as the initial upgrade may need extra work. * Updates references to the Composer PHPCS plugin to make sure these reference the new name and link to the correct GH repo (as the repo has moved). * Removes the reference to the VIP ruleset which was removed in WPCS 2.0.0 from the "Rulesets" section. * Adds links to the "customizable properties" section for where to find customizable properties for PHPCS native sniffs and sniffs from PHPCSExtra. * Adds the `VariableAnalysis` standard and the `VIP Coding Standards` to the list of optional additional rulesets to use. * Updates the command and output for the example run. * Removes the links to IDE related tutorials in favour of a link to the wiki (to save us having to maintain this list in multiple places). * Ensures the text consistently uses `WordPressCS` instead of `WPCS`. Closes #481 Closes #1821 Closes #1901
This commit updates the CONTRIBUTING guide to be in line with WordPressCS 3.0.0. This commit: * Updates the information about usage of upstream sniffs and reporting upstream issues. * Updates the information on creating a pull request. * Removes the information about the use of a long running release PR (as we don't do this anymore in practice). * Updates the information on running the unit tests, including the information on how to get set up with cloned dependencies. * Updates the examples test run output and removes the outdated the asciinema image. * Updates the code fragments and example output used in the tutorial part to be in line with the current code and run instructions. * Ensures the text consistently uses `WordPressCS` instead of `WPCS`. * Replaced some ablist language.
Change `WPCS` to `WordPressCS` in miscellaneous files.
GaryJones
approved these changes
Aug 20, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✅
dingo-d
approved these changes
Aug 20, 2023
Cricky.. you both are quick! Do we want to merge this already or leave it for just before the release ? I'm fine with merging it now as it won't be long for the release anymore anyway. |
dingo-d
deleted the
feature/docs-update-readme-contributing-et-al-3.0.0
branch
August 20, 2023 18:40
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README: updates for WordPressCS 3.0.0
This commit updates the README guide to be in line with WordPressCS 3.0.0.
This commit:
composer create-project
.VariableAnalysis
standard and theVIP Coding Standards
to the list of optional additional rulesets to use.WordPressCS
instead ofWPCS
.Closes #481
Closes #1821
Closes #1901
CONTRIBUTING: updates for WordPressCS 3.0.0
This commit updates the CONTRIBUTING guide to be in line with WordPressCS 3.0.0.
This commit:
WordPressCS
instead ofWPCS
.Docs: miscellaneous changes
Change
WPCS
toWordPressCS
in miscellaneous files.