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

Correct spelling issues in readme #129

Merged
merged 1 commit into from
Dec 4, 2023

Conversation

DannyvdSluijs
Copy link
Contributor

Corrects spelling issues in README.md

Description

Corrects the spelling to GitHub (as the brand name is with capital H) and wraps the directory name tools with backticks to clarify the directory is referenced.

Suggested changelog entry

Correct spelling issues in README.md

Related issues/external references

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change.
  • I have read the Contribution Guidelines.
  • I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
  • I have added tests to cover my changes.
  • I have verified that the code complies with the projects coding standards.
  • [Required for new sniffs] I have added XML documentation for the sniff.

@DannyvdSluijs
Copy link
Contributor Author

There is another change to the README.md that could be part of this PR. Since Greg mentioned back in 2019 that phpcs/phpcbf support for CSS and JS is removed and will be fully removed in V4.0 we might want to remove this from the readme which currently reads

the main phpcs script that tokenizes PHP, JavaScript and CSS files to

Some issue reports have been linked to the same item from Greg

I'm curious about your opinion @jrfnl. I'll consider a thumbs up emoji as a go and will amend the PR with that change. I'm positive about this change as it reduces the "official" scope and therefore any problem related to CSS and JS. Which are a completely different ecosystem with their own tools.

Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @DannyvdSluijs! Approving as-is.

@jrfnl jrfnl added this to the 3.8.0 milestone Dec 4, 2023
@jrfnl
Copy link
Member

jrfnl commented Dec 4, 2023

There is another change to the README.md that could be part of this PR. Since Greg mentioned back in 2019 that phpcs/phpcbf support for CSS and JS is removed and will be fully removed in V4.0 we might want to remove this from the readme which currently reads

the main phpcs script that tokenizes PHP, JavaScript and CSS files to

I'm curious about your opinion @jrfnl. I'll consider a thumbs up emoji as a go and will amend the PR with that change. I'm positive about this change as it reduces the "official" scope and therefore any problem related to CSS and JS. Which are a completely different ecosystem with their own tools.

@DannyvdSluijs As things are JS and CSS are still supported in v3.x. Support is only removed in v 4.0 and that has not been released yet. Changing the README to remove mention of JS/CSS is not for now, but for when the 4.0 release gets tagged. (and I wouldn't be surprised if those references have already been removed in the 4.0 branch)

It is one of the reasons why I'd like to get the 4.0 release out of the door sooner rather than later, but there are a number of things which I believe need to happen before it can be released, so it will still be a number of months before we get there.

@jrfnl jrfnl merged commit 46d8b1c into PHPCSStandards:master Dec 4, 2023
34 checks passed
jrfnl added a commit that referenced this pull request Dec 4, 2023
jrfnl added a commit that referenced this pull request Dec 4, 2023
DannyvdSluijs pushed a commit to DannyvdSluijs/PHP_CodeSniffer_Continuation that referenced this pull request Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants