crazyfactory / crazyfactory/php-sniffs
Should we enforce function docblock ?
Open
Nobody has claimed this yet.
question
- Dominant language
- PHP
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Most of the time when introducing new functions, I forget to put the docblock and will notice this once someone review my code.
Is it too strict to enforce function docblock ? If not then we should do this so that we do not forget to put it.
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
The issue names no files, tests, or entry points. Review the existing PHP sniffs and their tests first, then clarify whether function docblocks should be universally required and what exceptions apply; done should include an agreed enforcement rule and corresponding test coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100