Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Autogenerate JSON Schema and Documentation

Abierto
#4 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
php, typescript

Línea de trabajo

Comienza comparando el generador de TypeScript en packages/playground/blueprints/bin/generate-schema.js con el public/blueprint-schema.json versionado y enlazado en el issue; después, inspecciona el código fuente del blueprint de PHP y sus definiciones de argumentos de pasos. Define cómo deben representarse los argumentos de PHP antes de implementar la generación; se considera terminado cuando el esquema de PHP y la documentación se generan a partir del código y se mantienen actualizados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Architecture documentation

Typescript Blueprints shipped a JSON Schema and documentation generated from the TypeScript source:

https://github.com/WordPress/wordpress-playground/blob/ef1eb3f57ee251ec98f6075ff7e83d22add188e0/packages/playground/blueprints/public/blueprint-schema.json

The PHP version could do the same to ensure the schema and the documentation are always up to date with the code. This may require taking specific design choices, such as shipping steps arguments as classes:

class WriteFileStepArgs implements StepArgs {
	public $file;
	public string $toPath;

	/**
	 * @param $file
	 * @param string $toPath
	 */
	public function __construct( $file, string $toPath ) {
		$this->file   = $file;
		$this->toPath = $toPath;
	}

}
Lenguaje dominante
PHP
Estrellas
62
Forks
23
Merge medio
4 h 12 min
PR fusionados (30 d)
1

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de WordPress/php-toolkit

Todos los issues de WordPress/php-toolkit

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.