Skip to content

Commit 527f794

Browse files
Update README.md
1 parent cbcaec1 commit 527f794

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
@@ -9,6 +9,18 @@ Code Climate - https://codeclimate.com
99

1010
**Important:** If you encounter an error involving SSL certificates, see the **Known Issue: SSL Certificate Error** section below.
1111

12+
# Important FYIs
13+
14+
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:
15+
16+
* **Default branch only:** We only support test coverage for your [default branch](http://docs.codeclimate.com/article/151-glossary-default-branch). Be sure to check out this branch before running your tests.
17+
* **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.
18+
19+
**Note:** There is one exception to this rule. We've specifically built an integration with [Solano Labs](https://www.solanolabs.com/) to support parallel tests.
20+
21+
**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.
22+
* **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.
23+
1224
## Requirements
1325

1426
There are several requirements you'll need in order to use the PHP test reporter on your system:
@@ -82,6 +94,10 @@ right hand side of your feed.
8294
Please contact [email protected] if you need any assistance setting
8395
this up.
8496

97+
## Troubleshooting
98+
99+
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.
100+
85101
## Known Issue: SSL Certificate Error
86102

87103
If you encounter an error involving SSL certificates when trying to report

0 commit comments

Comments
 (0)