mirror of https://github.com/davisking/dlib.git
Improve issue template (#2741)
* Create but report template * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Update bug.yml * Create feature request template * Update feature.yml * Update feature.yml * Update feature.yml * Remove ISSUE_TEMPLATE * Create config.yml
This commit is contained in:
Adrià Arrufat
GitHub
parent
3c0b3620af
commit
310a37f452
|
|
@ -0,0 +1,71 @@
|
|||
name: Bug Report
|
||||
description: Create a bug report.
|
||||
title: "[Bug]: "
|
||||
labels: bug
|
||||
assignees: []
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Before you ask a question, check Google for a solution, [the dlib FAQ](http://dlib.net/faq.html), or consult the dlib documentation. Every single function in dlib is documented in detail. If you obviously haven't read the documentation your issue will be closed.
|
||||
- type: dropdown
|
||||
id: platform
|
||||
attributes:
|
||||
label: What Operating System(s) are you seeing this problem on?
|
||||
description: Select all that apply
|
||||
multiple: true
|
||||
options:
|
||||
- Linux (x86-64)
|
||||
- Linux (aarch64)
|
||||
- macOS (Intel)
|
||||
- macOS (Apple Silicon)
|
||||
- Windows
|
||||
- Other (plase, specify in the Steps to Reproduce)
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: dlib version
|
||||
description: "The commit hash, tag name, or package version"
|
||||
placeholder: "19.24"
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: compiler
|
||||
attributes:
|
||||
label: Compiler
|
||||
description: "The compiler and version you used to build dlib from source"
|
||||
placeholder: "e.g.: GCC 9, MSVC 19, clang 10"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: |
|
||||
A clear and concise description of what you expected to happen
|
||||
- type: textarea
|
||||
id: current
|
||||
attributes:
|
||||
label: Current Behavior
|
||||
description: A clear and concise description of what the bug is
|
||||
placeholder: |
|
||||
Tell us what happened. Expain in detail the current behavior.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: reproduce
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: Steps to reproduce the behavior
|
||||
placeholder: |
|
||||
Please include as much information as possible that can help to reproduce and
|
||||
understand the issue.
|
||||
|
||||
- type: textarea
|
||||
id: other
|
||||
attributes:
|
||||
label: Anything else?
|
||||
description: |
|
||||
Add any other context about the problem here.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 💬 Discussions
|
||||
url: https://github.com/davisking/dlib/discussions
|
||||
about: Please start usage discussions here
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
name: Feature Request
|
||||
description: Suggest an idea for dlib
|
||||
labels: type:enhancement
|
||||
assignees: []
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
It is OK to suggest interesting improvements to dlib, even if you are not volunteering to implement them.
|
||||
**However, the issue tracker is not a code writing service, do not ask for someone to write code for you**.
|
||||
E.g. Do not ask for feature improvements to the example programs.
|
||||
**If there is some feature improvement you want in an example program then it's up to you to write it**.
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Main idea
|
||||
description: Describe what you want to add or improve
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: other
|
||||
attributes:
|
||||
label: Anything else?
|
||||
description: Add any other context about the suggestion here.
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
IF YOU ARE REPORTING A BUG OR PROBLEM WITH DLIB THEN FILL OUT THE ENTIRE TEMPLATE BELOW. ISSUES ASKING QUESTIONS ABOUT WHY SOMETHING DOESN'T WORK THAT FAIL TO FILL OUT THE ENTIRE TEMPLATE WILL BE CLOSED.
|
||||
|
||||
It is OK to suggest interesting improvements to dlib, even if you are not volunteering to implement them. **However, the issue tracker is not a code writing service, do not ask for someone to write code for you.** E.g. Do not ask for feature improvements to the example programs. **If there is some feature improvement you want in an example program then it's up to you to write it**.
|
||||
|
||||
Before you ask a question, check Google for a solution, [the dlib FAQ](http://dlib.net/faq.html), or consult the dlib documentation. Every single function in dlib is documented in detail. If you obviously haven't read the documentation your issue will be closed.
|
||||
|
||||
If you aren't reporting a bug or problem with dlib then delete this template and write whatever you want here.
|
||||
|
||||
<!-- ================================================================== -->
|
||||
<!-- ================== BUG/PROBLEM REPORT TEMPLATE ================== -->
|
||||
<!-- ================================================================== -->
|
||||
|
||||
|
||||
<!-- Delete the above instructions and then provide a general summary of the issue in the Title above. Then fill out the template below. FAILURE TO FILL OUT EVERY PART WILL RESULT IN YOUR ISSUE BEING CLOSED -->
|
||||
|
||||
## Expected Behavior
|
||||
<!--- Tell us what should happen. What were you doing? What part of dlib are you using? What do you think should happen? -->
|
||||
|
||||
## Current Behavior
|
||||
<!--- Tell us what happens instead of the expected behavior. If you get an error, include the entire error message in the bug report. DO NOT POST SCREEN SHOTS. Paste in the text instead. If the issue is some kind of build problem, include the entire CMake output along with the error message. -->
|
||||
|
||||
## Steps to Reproduce
|
||||
<!--- Provide an unambiguous set of steps to reproduce this problem. What exactly do I have to type to reproduce your error? If you don't post complete instructions you are much less likely to get help. -->
|
||||
|
||||
|
||||
|
||||
* **Version**: <!-- What version of dlib? -->
|
||||
* **Where did you get dlib**: <!-- Did you get it from an official source like dlib.net, this github repo, or somewhere else? -->
|
||||
* **Platform**: <!-- include something like `lsb_release -a` output, or if Windows, version and 32-bit or
|
||||
64-bit -->
|
||||
* **Compiler**: <!-- What compiler are you using? What version of that compiler? -->
|
||||
Loading…
Reference in New Issue