Conversation
|
By the way, do we need a template for documentation? I saw there were some issues on documentation as well. |
|
Thank you! Perhaps we need some "other" category for Epics/stories (like support of new compiler / OS), Evolution proposals or improvement discussions. Lack of documentation details is a "bug" or "feature"? We could add separate "documentation" category for them (or reuse "bug"). It makes sense to avoid loosing of existed template helper. |
|
Thanks a lot! The solution looks great! |
I think it is hard to cover all the topics. From my perspective, evolution proposals / improvement discussions/ support of new platforms can all go to feature request. But at least, users can use the old template with a click on the "Open a blank issue" as follows.
It is not really blank, since
I am thinking of adding a separate category for "documentation" to use the auto-label feature that GitHub provides. For example, issue created from the "documentation" template can be automatically labelled with "documentation". |
asmorkalov
left a comment
There was a problem hiding this comment.
👍 Works for me. Please squash commits and I'll merge it.
078d14d to
4d0123c
Compare
|
Commits are squashed. |
| label: Issue submission checklist | ||
| options: | ||
| - label: I report the issue, it's not a question | ||
| required: true |
There was a problem hiding this comment.
Perhaps it would be better not to make all check boxes "required", because some issues do not have reproducer code or related data file or reporter does not have ability to check if the problem exists in the latest OpenCV release, etc. We make people "lie" by demanding checking all boxes to file an issue 😃
Alternatively some statements can be rephrased, e.g. "I've attached a reproducer or this statement is not applicable"
There was a problem hiding this comment.
Thanks for the review! This is indeed a good suggestion. The last three checkboxes are not required anymore, but the first checkbox "I report the issue, it's not a question" is still required.
I have reservations on the rephrasing since it makes people click the checkbox anyway, and this could confuse reviewers whether the reporter attaches reproducer or the statement is not applicable.
mshabunin
left a comment
There was a problem hiding this comment.
Looks good to me besides minor cosmetic comment.
request and documentation
4d0123c to
692c536
Compare
|
Should we turn on the auto-label feature for bug report (label with "bug") and feature request (label with "feature")? |
|
Imho, we do not need auto-labeling for now. Let's merge it as is and add enhancements later. |
This pull request enables template chooser with templates for bug report and feature request. See my fork for the effect: https://github.com/fengyuentau/opencv/issues/new/choose. Note these changes only take effect if they are put in the default branch.
Github documentation for configuring issue templates: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
Pull Request Readiness Checklist
See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request
Patch to opencv_extra has the same branch name.