Skip to content
This repository was archived by the owner on Jul 19, 2025. It is now read-only.

Commit 597b744

Browse files
Update README.md
1 parent 592638f commit 597b744

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ Climate's hosted, automated code review service. Based on SimpleCov.
77

88
Code Climate - [https://codeclimate.com](https://codeclimate.com)
99

10+
# Important FYIs
11+
12+
Across the many different testing frameworks, setups, and environments, there are lots of variables at play. Before setting up test coverage, it's important to understand what we do and do not currently support:
13+
14+
* **Default branch only:** We only support test coverage for your default branch. Be sure to check out this branch before running your tests.
15+
* **Single payload:** We currently only support a single test coverage payload per commit. If you run your tests in multiple steps, or via parallel tests, Code Climate will only process the first payload that we receive. If you are using a CI, be sure to check if you are running your tests in a parallel mode.
16+
17+
**Note:** There is one exception to this rule. We've specifically built an integration with Solano Labs to support parallel tests.
18+
19+
**Note:** If you've configured Code Climate to analyze multiple languages in the same repository (e.g., Ruby and JavaScript), we can nonetheless only process test coverage information for one of these languages. We'll process the first payload that we receive.
20+
* **Invalid File Paths:** By default, our test reporters expect your application to exist at the root of your repository. If this is not the case, the file paths in your test coverage payload will not match the file paths that Code Climate expects. For our Ruby test reporter, [we have a work-around to this issue](http://docs.codeclimate.com/article/220-help-im-having-trouble-with-test-coverage#ruby_sub_folder).
21+
1022
## Installation
1123

1224
This gem requires a user, but not necessarily a paid account, on Code Climate, so if you don't have one the
@@ -57,6 +69,10 @@ end
5769
CodeClimate::TestReporter.start
5870
```
5971

72+
## Troubleshooting
73+
74+
If you're having trouble setting up or working with our test coverage feature, [see our detailed help doc](http://docs.codeclimate.com/article/220-help-im-having-trouble-with-test-coverage), which covers the most common issues encountered.
75+
6076
## Extending Simplecov with other formatters
6177

6278
Since ruby-test-reporter 0.4.0 you can use `CodeClimate::TestReporter::Formatter` as a Simplecov formatter directly. Just add the formatter to your Simplecov formatter in addition to the rest of your configuration:

0 commit comments

Comments
 (0)