DOC ask for non-regression test for bug-fix Issue#8679 - #8817
DOC ask for non-regression test for bug-fix Issue#8679#8817puneetmathurDS wants to merge 1 commit into
Conversation
|
@glemaitre All checks have passed and there are no conflicts is somebody going to merge this PR? |
| @@ -1,3 +1,4 @@ | |||
| *.bat | |||
There was a problem hiding this comment.
This seems not relevant to the PR
| different options of the code. | ||
| different options of the code. | ||
|
|
||
| Regression testing is used to identify and validate any code committed to the repository and see if it does not break any existing code. Any changes made to the existing code in repository such as feature enhancements, bug fixes, document changes, hot fixes, config changes or any other changes to the scikit-learn repository are tested using regression tests. During these tests both functional and non-functional areas of the features are tested. Regression testing also ensures that the change being proposed works well with other parts of the software as a whole in an integrated way. Any bug-fix or change in sklearn repository needs a regression test due to the above reasons. |
There was a problem hiding this comment.
I feel like there should be a more granular explanation of when PRs should be accompanied by tests - e.g. in most cases documentation edits won't need one
There was a problem hiding this comment.
I agree. I would go with something simpler like:
In addition, a non-regression test should go along each bug-fix to ensure that such
bug will not occur in the future.
In addition, try to not go over 80 characters also in *.rst.
| @@ -464,7 +454,9 @@ is a corner-stone of the scikit-learn development process. For this | |||
| purpose, we use the `nose <http://nose.readthedocs.io/en/latest/>`_ | |||
There was a problem hiding this comment.
nose is being phased out in favor of py.test, correct?
| branch, you will need to `rebase your branch on master | ||
| <http://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html#rebasing-on-master>`_. | ||
| Please avoid merging master branch into yours. If you did it anyway, you can fix | ||
| it following `this example |
There was a problem hiding this comment.
maybe we should link to the scipy article or embed example git commands instead of linking to an issue comment
There was a problem hiding this comment.
There something with your branch. You are not synchronized. I made changes in PR #8753 and you should not have the previous version here.
| branch, you will need to `rebase your branch on master | ||
| <http://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html#rebasing-on-master>`_. | ||
| Please avoid merging master branch into yours. If you did it anyway, you can fix | ||
| it following `this example |
There was a problem hiding this comment.
There something with your branch. You are not synchronized. I made changes in PR #8753 and you should not have the previous version here.
|
|
||
| The :mod:`sklearn.utils.multiclass` module contains useful functions | ||
| for working with multiclass and multilabel problems. | ||
| No newline at end of file |
There was a problem hiding this comment.
I am confused where did the other changes in the file come from? I did not make those changes.
| different options of the code. | ||
| different options of the code. | ||
|
|
||
| Regression testing is used to identify and validate any code committed to the repository and see if it does not break any existing code. Any changes made to the existing code in repository such as feature enhancements, bug fixes, document changes, hot fixes, config changes or any other changes to the scikit-learn repository are tested using regression tests. During these tests both functional and non-functional areas of the features are tested. Regression testing also ensures that the change being proposed works well with other parts of the software as a whole in an integrated way. Any bug-fix or change in sklearn repository needs a regression test due to the above reasons. |
There was a problem hiding this comment.
I agree. I would go with something simpler like:
In addition, a non-regression test should go along each bug-fix to ensure that such
bug will not occur in the future.
In addition, try to not go over 80 characters also in *.rst.
|
Closed by #8850. |
Reference Issue
Add short explanation of regression test do contributing docs. #8679
What does this implement/fix? Explain your changes.
Added short explanation of regression test in contributing docs as a paragraph. For Issue#8679
Any other comments?
This Pull request should be proper.