itsgoingd / itsgoingd/clockwork
phpdoc for integration methods
Open
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 6k
- Forks
- 333
- Avg merge
- 5m
- Merged PRs (30d)
- 1
Description
would be great to have phpdocs for the most used methods which are required for integration with the host applications, e.g.
resolveAsCommandresolveAsQueueJob
at best we could have psalm or phpstan like phpdocs, which are pretty precise about the contents of the arrays involved see e.g.
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 locating the resolveAsCommand and resolveAsQueueJob integration methods. Review the linked PHPStan documentation on general arrays and array shapes, then document the methods with precise PHPDocs for their array contents; done means the most-used integration methods have usable type information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100