Skip to content

Commit dde5662

Browse files
authored
Updating contribution to aid debugging (#961)
* Updating contribution to aid debugging * More explicit instructions
1 parent 0def226 commit dde5662

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,11 @@ You may then run a specific module, test case, or unit test respectively:
239239
$ pytest tests/test_datasets/test_dataset.py::OpenMLDatasetTest::test_get_data
240240
```
241241

242+
*NOTE*: In the case the examples build fails during the Continuous Integration test online, please
243+
fix the first failing example. If the first failing example switched the server from live to test
244+
or vice-versa, and the subsequent examples expect the other server, the ensuing examples will fail
245+
to be built as well.
246+
242247
Happy testing!
243248

244249
Documentation

doc/contributing.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,10 @@ In particular, a few ways to contribute to openml-python are:
1818
are hosted in separate repositories and may have their own guidelines.
1919
For more information, see the :ref:`extensions` below.
2020

21-
* Bug reports. If something doesn't work for you or is cumbersome, please
22-
open a new issue to let us know about the problem.
23-
See `this section <https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md#reporting-bugs>`_.
21+
* Bug reports. If something doesn't work for you or is cumbersome, please open a new issue to let
22+
us know about the problem. See `this section <https://github.com/openml/openml-python/blob/develop/CONTRIBUTING.md#reporting-bugs>`_.
2423

25-
* `Cite OpenML <https://www.openml.org/cite>`_ if you use it in a scientific
26-
publication.
24+
* `Cite OpenML <https://www.openml.org/cite>`_ if you use it in a scientific publication.
2725

2826
* Visit one of our `hackathons <https://meet.openml.org/>`_.
2927

0 commit comments

Comments
 (0)