From c2f26592c92a6a2cdc2acf033a5727f4bb1eb1d5 Mon Sep 17 00:00:00 2001 From: Alexander Farkas Date: Tue, 29 Dec 2020 09:57:18 +0100 Subject: [PATCH 1/2] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 11 ++++++++--- .github/ISSUE_TEMPLATE/feature_request.md | 22 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/other-issues.md | 10 ++++++++++ 3 files changed, 40 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/other-issues.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 53708ad5..b99f98eb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -14,12 +14,17 @@ A short, clear and concise description of what the bug is. Provide a url where the bug can be reproduced. (Use for example: [jsbin](https://jsbin.com), [codepen](https://codepen.io), [jsfiddle.net](https://jsfiddle.net) or [codesandbox.io](https://codesandbox.io) **Steps to reproduce the behavior:** -Provide all necessary steps to reproduce the bug. +Provide all necessary steps to reproduce the bug. -**What is the expected behavior** +**What is the expected behavior:** -**What happened instead** +**What happened instead:** **In what environment (browser/device etc.) does this bug happen/not happen:** + +**Keywords help others to find this issue:** + +⚠️ If you have a question about how to use lazysizes open a [discussion](/lazysizes/discussions) instead. +⚠️ If you do not provide enough information to reproduce your bug. We won't be able to work on the issue. In most cases just providing a fraction of your code is not enough! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..4b53671e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. + +⚠️ If you have a question about how to use lazysizes open a [discussion](/lazysizes/discussions) instead. diff --git a/.github/ISSUE_TEMPLATE/other-issues.md b/.github/ISSUE_TEMPLATE/other-issues.md new file mode 100644 index 00000000..7e2637a5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other-issues.md @@ -0,0 +1,10 @@ +--- +name: Other issues +about: If the other templates don't fit... +title: '' +labels: '' +assignees: '' + +--- + +⚠️ If you have a question about how to use lazysizes open a [discussion](/lazysizes/discussions) instead. From 94d7638e7be544cb1a6bf2d22b0357befae90585 Mon Sep 17 00:00:00 2001 From: Alexander Farkas Date: Tue, 29 Dec 2020 11:27:01 +0100 Subject: [PATCH 2/2] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/ISSUE_TEMPLATE/question.md | 20 ++++++++++++++++++++ 3 files changed, 23 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b99f98eb..1fd85640 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,7 +2,7 @@ name: Bug report about: Create a report to help us improve title: '' -labels: '' +labels: bug assignees: '' --- @@ -26,5 +26,5 @@ Provide all necessary steps to reproduce the bug. **Keywords help others to find this issue:** -⚠️ If you have a question about how to use lazysizes open a [discussion](/lazysizes/discussions) instead. +⚠️ Search for existing open/closed issues/discussions before you report the issue. ⚠️ If you do not provide enough information to reproduce your bug. We won't be able to work on the issue. In most cases just providing a fraction of your code is not enough! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 4b53671e..6a10fa2f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -19,4 +19,4 @@ A clear and concise description of any alternative solutions or features you've **Additional context** Add any other context or screenshots about the feature request here. -⚠️ If you have a question about how to use lazysizes open a [discussion](/lazysizes/discussions) instead. +⚠️ Consider that most features can be solved by the simple plugin architecture and that most features doesn't need to be added to the core. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..8dd05f1a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,20 @@ +--- +name: Question +about: Ask questions about the API and integration +title: '' +labels: question +assignees: '' + +--- + +**Describe your problem/question** +A complete but concise description of your problem and how you are trying to fix it and where you are struggling. + +**Make it reproduce-able** +If your problem is with code or the expected answer should include code provide a live code example using https://jsbin.com/ or https://codesandbox.io/. + +**Add tags/keywords** +Make sure others can find your problem. + +⚠️ Search for existing open/closed issues/discussions before you ask your question. +⚠️ I work on my spare time on helping users out. This means make it easy for me to simply see your live problem and help to fix it. If I have to generate a site to reproduce your problem myself I probably won't help you.