Put Reported Issue's Mass in Read Up Contents #45
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this was old & not up to date or useful: I'm co-opting it to run the spec suite in docker to avoid local setup woes.
| private | ||
|
|
||
| def read_up_path | ||
| relative_path = "../../../../config/contents/duplicated_code.md.erb" |
There was a problem hiding this comment.
Thoughts on making this a constant?
|
I like the extracted class! LGTM |
One aspect of the duplication engine that is different from other engines and that can be frustrating is that the main dial you can turn to adjust the results, mass threshold, is a completely invisible value once the issue has been reported to CC (either .com or CLI). As a user, this makes the engine difficult to configure because even though the README documents how to set the mass threshold, the fact that you can't ever see what mass issues have makes the feedback loop between getting results and deciding what your settings should be basically impossible. This is an attempt to remediate this problem by describing generally what mass is, and what its specific value for an issue is, within the read up contents. This makes the value accessible without unduly cluttering the description with that value.
wfleming
force-pushed
the
will/mass-in-readup
branch
from
1e5fd2a to
4af82cc
Compare
wfleming
added a commit
that referenced
this pull request
Nov 18, 2015
Put Reported Issue's Mass in Read Up Contents
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
One aspect of the duplication engine that is different from other engines
and that can be frustrating is that the main dial you can turn to adjust
the results, mass threshold, is a completely invisible value once the issue
has been reported to CC (either .com or CLI). As a user, this makes the
engine difficult to configure because even though the README documents how
to set the mass threshold, the fact that you can't ever see what mass
issues have makes the feedback loop between getting results and deciding
what your settings should be basically impossible.
This is an attempt to remediate this problem by describing generally what
mass is, and what its specific value for an issue is, within the read up
contents. This makes the value accessible without unduly cluttering the
description with that value.
Also some other minor cleanup of copy & the test suite I ran into while I was doing this.
👀 @codeclimate/review