Updating contribution to aid debugging #961
Conversation
CONTRIBUTING.md
Outdated
| @@ -239,6 +239,9 @@ You may then run a specific module, test case, or unit test respectively: | |||
| $ pytest tests/test_datasets/test_dataset.py::OpenMLDatasetTest::test_get_data | |||
| ``` | |||
|
|
|||
| *NOTE*: In the case the examples build fails during the Continuous Integration test online, please check if | |||
| the first failing example file changed the server that the example fetches from. | |||
There was a problem hiding this comment.
You mean if the test server is used (or production, depending on the example)? I think it would help to state it explicitly and why this may lead to failure. Why would it only fail on CI, and not locally?
There was a problem hiding this comment.
Updated it. Not sure if a person contributing to the repo will be calling make html to test the examples docs. I thought that it is more likely to see such errors during the Travis run, hence I mentioned the online failure. Also, I haven't myself tested if such errors appear on local builds.
There was a problem hiding this comment.
Makes sense. The clarification now makes me understand what kind of problem I am hoping to identify :) looks good to me!
Codecov Report
@@ Coverage Diff @@
## develop #961 +/- ##
===========================================
- Coverage 87.67% 87.61% -0.07%
===========================================
Files 37 37
Lines 4504 4504
===========================================
- Hits 3949 3946 -3
- Misses 555 558 +3
Continue to review full report at Codecov.
|
What does this PR implement/fix? Explain your changes.
Adds a NOTE to the contribution guidelines to help debug failing examples.
Currently, if the first failing example switched the server from live to test or vice-versa, and the subsequent example expects the other server, the following examples fail to be built as well.