From 310a37f4525ec6d217d3425938dbcfadd5aeada2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A0=20Arrufat?= <1671644+arrufat@users.noreply.github.com> Date: Sun, 12 Mar 2023 23:07:55 +0900 Subject: [PATCH] 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 --- .github/ISSUE_TEMPLATE/bug.yml | 71 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature.yml | 24 ++++++++++ ISSUE_TEMPLATE.md | 31 ------------- 4 files changed, 100 insertions(+), 31 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml delete mode 100644 ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..1ee2829ba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3b74698b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 000000000..0ae34b0c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -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. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 6afd70908..000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -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. - - - - - - - - -## Expected Behavior - - -## Current Behavior - - -## Steps to Reproduce - - - - -* **Version**: -* **Where did you get dlib**: -* **Platform**: -* **Compiler**: