Yoast / Yoast/yoastcs

Code style should enforce documentation for actions and filters

Open
#7 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Status: wait for upstream/WordPressCS Type: enhancement
Dominant language
PHP
Stars
22
Forks
1
PR merge metrics
No merged PRs in 30d

Description

every do_action and apply_filters should be documented.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing code-style checks for WordPress actions and filters, then review how they detect and report violations. Clarify what counts as documentation for each hook and how the repository tests coding-standard rules. Done means both do_action and apply_filters usage are consistently checked with coverage for the expected documented and undocumented cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.