[Meta] Documentation
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 247
- Forks
- 45
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
I know this package is still in wild development, but I'm trying to wrap my head on how this works internally to find out what information I can extract in what ways. It seems quite promising, thanks for your great work guys!
There are literally 1300 line files* with 0 comments in it. I know good code is self-documenting, but sometimes describing flow in your program is still really helpful.
- e.g. https://github.com/ircmaxell/php-cfg/blob/master/lib/PHPCfg/Parser.php
(edit correction: Parser has about 3 PhpDocblocks)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing lib/PHPCfg/Parser.php, the example named in the issue, and identify the undocumented program flow and other large files that need explanation. The issue does not define a file list or acceptance criteria; done would require agreed documentation scope and useful comments or documentation for the selected code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100