WordPress / WordPress/php-toolkit
PHP Coding standards fine-tuning
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 61
- Forks
- 21
- Avg merge
- 19h 34m
- Merged PRs (30d)
- 7
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the current coding-standards and linting configuration, then examine the listed PHPCS findings, including testUnzipFileWhenUsingAbsolutePath(). Decide which WordPress Coding Standards apply to this standalone library and document the accepted exceptions. Done means the applicable standards are agreed and the resulting lint violations are resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100