Skip to content

Commit fad0826

Browse files
authored
DOC Adapt explanation of non-regression test (scikit-learn#32466)
1 parent 5b75124 commit fad0826

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

doc/developers/contributing.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -459,11 +459,9 @@ complies with the following rules before marking a PR as "ready for review". The
459459
build the docs: please refer to :ref:`generated_doc_CI`.
460460

461461
4. **Tests are necessary for enhancements to be
462-
accepted**. Bug-fixes or new features should be provided with
463-
`non-regression tests
464-
<https://en.wikipedia.org/wiki/Non-regression_testing>`_. These tests
465-
verify the correct behavior of the fix or feature. In this manner, further
466-
modifications on the code base are granted to be consistent with the
462+
accepted**. Bug-fixes or new features should be provided with non-regression tests.
463+
These tests verify the correct behavior of the fix or feature. In this manner,
464+
further modifications on the code base are granted to be consistent with the
467465
desired behavior. In the case of bug fixes, at the time of the PR, the
468466
non-regression tests should fail for the code base in the ``main`` branch
469467
and pass for the PR code.
@@ -1495,7 +1493,11 @@ up this process by providing your feedback.
14951493
parameters, their values, value types, and combinations tested? Do
14961494
the tests validate that the code is correct, i.e. doing what the
14971495
documentation says it does? If the change is a bug-fix, is a
1498-
non-regression test included?
1496+
non-regression test included? These tests verify the correct behavior of the fix
1497+
or feature. In this manner, further modifications on the code base are granted to
1498+
be consistent with the desired behavior. In the case of bug fixes, at the time of
1499+
the PR, the non-regression tests should fail for the code base in the ``main``
1500+
branch and pass for the PR code.
14991501

15001502
- Do the tests pass in the continuous integration build? If
15011503
appropriate, help the contributor understand why tests failed.

0 commit comments

Comments
 (0)