magento / magento/community-features
[DevEx] Implement static test to prevent auto-generated class/method descriptions
Open
Nobody has claimed this yet.
architecture team request
devguild
good first issue
Imagine2018
Priority: P3
- Dominant language
- No language data
- Stars
- 46
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
Automatically generated descriptions do not add any value and must be avoided.
It is possible to write a static test which would catch common patterns like, but not limited to:
- `Created by PhpStorm`
- `Class ClassName`
- Empty descriptions
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 repository's existing static-test or code-quality entry point. Add coverage for common generated descriptions such as `Created by PhpStorm`, `Class ClassName`, and empty descriptions; done means the test reliably rejects these patterns without blocking valid descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- developer-experience, testing-qa
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100