Expand/improve docs (https://php.github.io/php-src/)
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- C
- Sterne
- 40.4k
- Forks
- 8.1k
- Ø Merge
- 2 T. 13 Std.
- Gemergte PRs (30 T.)
- 96
Beschreibung
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
zvalandzend_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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Durchsicht der vorhandenen Dokumentation unter php.github.io/php-src/ und der vorgeschlagenen Quellbereiche: zend_API.h, zend_portability.h, zend_compile.h, zend_globals.h, zend_globals_macros.h, zend_types.h und zend_hash.h. Grenze den breit gefassten Vorschlag auf einen abgestimmten Umfang für die Contributor-Dokumentation ein, dokumentiere anschließend die ausgewählten Makros, Typen, Muster oder Datenstrukturen und überprüfe, dass die veröffentlichte Dokumentation diesen Umfang abdeckt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- c
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100