Improve PHPDoc Consistency Across the Codebase
@Seraphim200001 ya está trabajando en esto.
Desde el 28/5/2026.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 48/100
Línea de trabajo
Start by reading the PHPStan setup introduced in PR #35, then inspect the project’s PHP classes and methods for array parameters, return types, and properties with missing or ambiguous PHPDoc. The issue describes a broad, progressive cleanup without naming files or tests, so first identify the annotations flagged by the current PHPStan configuration. Done means improving iterable value types and PHPDoc consistency while keeping stricter PHPStan analysis satisfied.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
While working on the PHPStan static analysis setup, several areas of the codebase were identified where PHPDoc annotations could be improved for better consistency and stronger static analysis support.
In particular, many array parameters, return types, and class properties would benefit from more explicit iterable value type annotations.
Proposed Improvements
- Add explicit iterable value types for arrays
- Improve PHPDoc consistency across classes and methods
- Refine parameter and return type annotations where helpful
- Reduce ambiguous or missing PHPDoc declarations
- Improve compatibility with stricter PHPStan analysis levels
Goal
The goal of this issue is to progressively improve the maintainability and static analysis quality of the project while keeping the codebase easier to understand and contribute to.
This work would complement the PHPStan setup introduced in PR #35.
Thanks @Seraphim200001
- Lenguaje dominante
- PHP
- Estrellas
- 20
- Forks
- 3
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de openapi/openapi-php-sdk
-
enhancement help wanted
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
openapi/openapi-php-sdk#34 ·
-
good first issue question
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
openapi/openapi-php-sdk#33 · 2 comentarios ·
-
enhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
openapi/openapi-php-sdk#32 ·
-
help wanted question
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
openapi/openapi-php-sdk#31 ·
-
enhancement good first issue
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
openapi/openapi-php-sdk#30 ·
Todos los issues de openapi/openapi-php-sdk
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
scanaislop/aislop#482 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
humanmade/publication-checklist#73 · 1 comentario ·
-
Do not throw `WordPress.Security.EscapeOutput.OutputNotEscaped` on `apply_shortcodes()`Posiblemente ocupada @tbradsha la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100