Expand/improve docs (https://php.github.io/php-src/)
まだ誰も着手していません。
- 主要言語
- C
- スター
- 40.4k
- フォーク
- 8.1k
- 平均マージ
- 2日 13時間
- マージ済み PR(30日)
- 96
説明
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず php.github.io/php-src/ にある既存のドキュメントと、提案されているソース領域(zend_API.h、zend_portability.h、zend_compile.h、zend_globals.h、zend_globals_macros.h、zend_types.h、zend_hash.h)を確認します。広範な提案を、合意したコントリビューター向けドキュメントの範囲に絞り込み、その後、選択したマクロ、型、パターン、またはデータ構造を文書化し、公開されたドキュメントがそれを網羅していることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- c
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100