Skip to content

Commit de4465d

Browse files
committed
Add section about generating function maps to contribution docs
1 parent 8031f45 commit de4465d

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ file. Note that this requires `phpize` to be run for PHP 8.2 to make use
3535
of all features. After changing a stub file, run `./build/gen_stub.php`
3636
to regenerate the corresponding arginfo files and commit the results.
3737

38+
## Generating function maps for static analysis tools
39+
40+
PHPStan and Psalm use function maps to provide users with correct type analysis
41+
when using this extension. To generate the function map, run the
42+
`generate-function-map` make target. The generated map will be stored in
43+
`scripts/functionMap.php`.
44+
3845
## Testing
3946

4047
The extension's test use the PHPT format from PHP internals. This format is

0 commit comments

Comments
 (0)