From 97a728e72256850fd1042c929500465b06153c1e Mon Sep 17 00:00:00 2001 From: figsoda Date: Sat, 13 Nov 2021 11:40:29 -0500 Subject: [PATCH] improve issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 12 ------ .github/ISSUE_TEMPLATE/bug-report.yml | 40 +++++++++++++++++++ .../documentation-improvement.md | 6 +-- .github/ISSUE_TEMPLATE/feature-request.md | 6 +++ .github/ISSUE_TEMPLATE/question.md | 6 +++ 5 files changed, 53 insertions(+), 17 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 1df76de..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: Bug Report -about: Any Ouch bug -title: '_[BUG]_ ' -labels: bug -assignees: '' - ---- - -Thanks for filling a bug report! - -Don't forget to add the `ouch` version for which this error occurred. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..9c5e36d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,40 @@ +name: Bug Report +description: Report a ouch bug +labels: [bug] +body: + - type: markdown + attributes: + value: Thanks for filling a bug report! + + - type: input + id: version + attributes: + label: Version + description: Version of ouch you encountered this error, or git commit hash if you are not using a versioned release + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + validations: + required: true + + - type: textarea + id: current + attributes: + label: Current Behavior + + - type: textarea + id: expected + attributes: + label: Expected Behavior + + - type: textarea + id: info + attributes: + label: Additional Information + description: > + Additional information that might help us debug this issue, + such as the operating system you are using or the files you tried to archive/extract diff --git a/.github/ISSUE_TEMPLATE/documentation-improvement.md b/.github/ISSUE_TEMPLATE/documentation-improvement.md index 9c0e616..b44ae39 100644 --- a/.github/ISSUE_TEMPLATE/documentation-improvement.md +++ b/.github/ISSUE_TEMPLATE/documentation-improvement.md @@ -1,10 +1,6 @@ --- name: Documentation Improvement -about: Improvements in repository markdown or code docs -title: '_[DOCS]_ ' +about: Improvements in repository markdown or code documentations labels: documentation -assignees: '' --- - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..8aa482b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,6 @@ +--- +name: Feature / Enhancement +about: Features or change you want to see in ouch +labels: enhancement + +--- diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..846e036 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,6 @@ +--- +name: Question +about: Ask a question about ouch. You can also ask questions in discussions: https://github.com/ouch-org/ouch/discussions +labels: question + +---