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

PHP Coding standards fine-tuning #59

Open
reimic opened this issue Mar 4, 2024 · 1 comment
Open

PHP Coding standards fine-tuning #59

reimic opened this issue Mar 4, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@reimic
Copy link
Collaborator

reimic commented Mar 4, 2024

With coding standards implemented and linting on the way, it is to be considered if this library should apply all WordPress coding standards.

Some of the prompts to consider:

phpcs: File operations should use WP_Filesystem methods instead of direct PHP filesystem calls.

(This library has no direct access to WordPress. And for good reason.)

phpcs: Missing doc comment for function testUnzipFileWhenUsingAbsolutePath()

(Expects docs for every test.)

phpcs: Missing short description in doc comment

(Expects description for every doc.)

phpcs: Missing @throws tag in function comment

… and more.

@adamziel
Copy link
Collaborator

adamziel commented Mar 5, 2024

phpcs: Missing @throws tag in function comment

This one sounds useful, the rest I'd disable for now. Good call. Let's pick and choose the rules that are the most useful and fine-tune them as we go.

@adamziel adamziel added the enhancement New feature or request label Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants