Skip to content

Commit 2af98d0

Browse files
Update README.md
1 parent 1ff9d8e commit 2af98d0

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# CodeclimateDiff
22

3-
This tool lets you see how your branch is affecting the code quality (what issues you've added, fixed, and what issues are outstanding in the files you've touched.)
3+
This tool lets you see how changes in your branch will affect the code quality (what issues you've added, fixed, and what issues are outstanding in the files you've touched that could be fixed while you're in the area.)
44

5-
It covers 3 kinds of code quality metrics (code smells, cyclomatic complexity, and similar code).
6-
7-
NOTE: similar code will only work correctly if you run a diff on all the files in your branch.
5+
It runs the https://hub.docker.com/r/codeclimate/codeclimate docker image under the hood, which pays attention to all the normal Code Climate configurations.
86

97

108
## Initial setup
@@ -140,6 +138,7 @@ NOTE: similar code will only work correctly if you run a diff on all the files i
140138
OR
141139
142140
# always analyzes all files rather than the changed files one by one, even if below the 'threshold_to_run_on_all_files' setting.
141+
# NOTE: similar code issues will only work 100% correctly if you use this setting (otherwise it might miss a similarity with a file you didn't change and think you fixed it)
143142
./bin/codeclimate_diff --all
144143
```
145144

@@ -178,7 +177,7 @@ With a few tweaks to your CI configuration, we can pull down the main build base
178177

179178
3. Create a personal access token with `read_api` access and save it in the `CODECLIMATE_DIFF_GITLAB_PERSONAL_ACCESS_TOKEN` env variable
180179

181-
Now when you run it on the changed files in your branch, it will refresh the baseline first!
180+
Now when you run it on the changed files in your branch, it will download the latest baseline first!
182181

183182
## Development
184183

0 commit comments

Comments
 (0)