whitesmith / whitesmith/rubycritic
Smell cost explanation?
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 3.5k
- Forks
- 234
- PR merge metrics
- No merged PRs in 30d
Description
Recently I modified the reek configuration to ignore some smells in some directories. I noticed that while the number of code smells for the files changed, the overall score didn't change. This was unexpected for me.
After diving deeper, I see that the cost of a Reek smell is 0. If I understand correctly, this means that smells found by Reek, don't have an impact on the cost, rating or overall score. If this is the case, this was unintuitive as our team have been trying to improve the score by address a lot of the reek smells.
Is there an explanation or documentation that summarises the idea behind the scoring? I have read the Core Metrics, Score and Rating and Code Climate Score Doc however, I feel it would be good to explicitly describe how the cost is determined and explicitly describe the intentions behind the cost and weights (i.e., why reek smells are 0 and why flog and flay costs are X).
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 with docs/core-metrics.md and compare its scoring description with the linked Code Climate Score Doc. Trace how smell costs and weights are represented in the repository, then document how cost affects rating and the overall score, including why Reek smells have zero cost. Done means the scoring rationale is explicit and understandable to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100