Expand/improve docs (https://php.github.io/php-src/)
Nessuno ha ancora preso questa issue.
- Lingua principale
- C
- Stelle
- 40.4k
- Fork
- 8.2k
- Merge medio
- 2g 13h
- PR unite (30g)
- 96
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando la documentazione esistente su php.github.io/php-src/ e le aree del codice sorgente proposte: zend_API.h, zend_portability.h, zend_compile.h, zend_globals.h, zend_globals_macros.h, zend_types.h e zend_hash.h. Riduci la proposta ampia a un ambito concordato per la documentazione destinata ai contributori, quindi documenta le macro, i tipi, i pattern o le strutture dati selezionati e verifica che la documentazione pubblicata li copra.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- c
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100