Skip to content

Updating contribution to aid debugging #961

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mfeurer merged 2 commits into from
Oct 20, 2020
Merged

Updating contribution to aid debugging #961

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e2c36c
Updating contribution to aid debugging
Neeratyoy Oct 20, 2020
14b3688
More explicit instructions
Neeratyoy Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,11 @@ 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
fix the first failing example. If the first failing example switched the server from live to test
or vice-versa, and the subsequent examples expect the other server, the ensuing examples will fail
to be built as well.

Happy testing!

Documentation
Expand Down
8 changes: 3 additions & 5 deletions doc/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,10 @@ In particular, a few ways to contribute to openml-python are:
are hosted in separate repositories and may have their own guidelines.
For more information, see the :ref:`extensions` below.

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

* `Cite OpenML <https://www.openml.org/cite>`_ if you use it in a scientific
publication.
* `Cite OpenML <https://www.openml.org/cite>`_ if you use it in a scientific publication.

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

Expand Down