You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I suggest we update sktime/PULL_REQUEST_TEMPLATE.md and add another subsection asking the author if they have added any new tests. This may be more important for bug-fixing PRs but is also relevant to PRs related to code enhancements.
It is considered good practice to add tests with newly added code to enforce the fact that the code actually works. This will reduce the chance of introducing logical bugs which often escape tests that only check for spec compliance
This line will serve as a cue for the author to add tests to ensure that further changes to these files won't introduce the same kind of bug.
Suggest a potential alternative/fix
#### Does your contribution introduce a new dependency? If yes, which one?<!--If your contribution does add a new hard dependency, we may suggest to initially develop your contribution in a separate companion package in https://github.com/sktime/ to keep external dependencies of the core sktime package to a minimum.-->#### Did you add any tests?
<! -- It is considered good practice to add tests whenever a new piece of code is added. While we don't mandate them, we encourage our contributors to add new tests to reduce the chance of introducing logical bugs. -->
#### What should a reviewer concentrate their feedback on?<!-- This section is particularly useful if you have a pull request that is still in development. You can guide the reviews to focus on the parts that are ready for their comments. We suggest using bullets (indicated by * or -) and filled checkboxes [x] here -->
The text was updated successfully, but these errors were encountered:
@achieveordie, good spot! We did not ask for this already in the current template? Apparently not!
Initially, I thought maybe it is better to modify it a little, to sth similar to "is the change covered by tests?" or "is there a test certifying for the change" - but there may be a better formulation than that. Since automated tests may already cover the change.
But, on second thought, perhaps "did you add any tests" is clearest - since this is mostly the requirement for beginneres, and the advanced contributors will know what to do in the less frequent cases that are different.
I also think it is a good idea! And I like the phrasing you used along the lines "it is best practice". I think some of the other phrasing might be a bit wordy, but overall I like the change/think it would help new contributors! :)
Describe the issue linked to the documentation
I suggest we update
sktime/PULL_REQUEST_TEMPLATE.md
and add another subsection asking the author if they have added any new tests. This may be more important for bug-fixing PRs but is also relevant to PRs related to code enhancements.It is considered good practice to add tests with newly added code to enforce the fact that the code actually works. This will reduce the chance of introducing logical bugs which often escape tests that only check for spec compliance
This line will serve as a cue for the author to add tests to ensure that further changes to these files won't introduce the same kind of bug.
Suggest a potential alternative/fix
The text was updated successfully, but these errors were encountered: