php / php/php-src

Expand/improve docs (https://php.github.io/php-src/)

Abierto
#15,954 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Category: Documentation Feature Status: Needs Triage
Lenguaje dominante
C
Estrellas
40.4k
Forks
8.1k
Merge medio
2 d 13 h
PR fusionados (30 d)
96

Descripción

Description

Having recently started contributing to PHP, I have found that I frequently needed to look through a bunch of different source files to figure out how different macros/types/patterns are used. I propose expanding https://php.github.io/php-src/ to better document these, to make things easier for new (and hopefully also existing?) contributors.

I'm happy to work on writing the documentation if it would be accepted, and some initial points that I suggest documenting are

  • parameter parsing and function declaration (lots of zend_API.h stuff)
  • the compatibility macros/debug tools/compiler hints (zend_portability.h)
  • data structures other than zval and zend_string, like class entries, properties, constants, and methods (zend_compile.h)
  • globals and the interaction with thread safety (zend_globals.h, zend_globals_macros.h)
  • arrays/HashTable (zend_types.h, zend_hash.h)

And there are probably a whole bunch of other areas that I just haven't run into

Guía de contribución

Abrir la 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.

Línea de trabajo

Comienza revisando la documentación existente en php.github.io/php-src/ y las áreas de código fuente propuestas: zend_API.h, zend_portability.h, zend_compile.h, zend_globals.h, zend_globals_macros.h, zend_types.h y zend_hash.h. Reduce la propuesta general a un alcance acordado para la documentación de contribuidores, documenta después las macros, los tipos, los patrones o las estructuras de datos seleccionados y verifica que la documentación publicada los cubra.

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

Evaluación

Stack tecnológico
c
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.