Better log messages (threshold parameters)
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 2.5k
- Forks
- 361
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 11
Description
At the moment most rules have no information about threshold parameter in the log messages.
For example: ExcessiveParameterList, ExcessivePublicCount, TooManyFields
Some other rules are more informative: ExcessiveClassComplexity
The developers reading messages like "Too many fields" can not orient themselves what the acceptable values really are.
[Synced from PivotalTracker: 'http://www.pivotaltracker.com/story/show/13431807']
Contributor guide
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 implementations of ExcessiveParameterList, ExcessivePublicCount, TooManyFields, and ExcessiveClassComplexity, then compare how their messages are produced. Update the less informative messages to include the relevant threshold parameters and verify the existing rule tests cover the resulting wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100