From db0e276c5b405a19616b1836dcfb86cbe7468505 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix?= Date: Sat, 8 Oct 2022 00:01:37 +0200 Subject: [PATCH 1/3] chore: update issue template --- .github/ISSUE_TEMPLATE/---bug-report.md | 46 --------- .github/ISSUE_TEMPLATE/---documentation.md | 26 ----- .github/ISSUE_TEMPLATE/---feature-request.md | 33 ------- .../---support-or-usage-question.md | 46 --------- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 99 +++++++++++++++++++ .github/ISSUE_TEMPLATE/DOCUMENTATION.yml | 30 ++++++ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml | 47 +++++++++ .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.yml | 92 +++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 9 files changed, 269 insertions(+), 151 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/---bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/---documentation.md delete mode 100644 .github/ISSUE_TEMPLATE/---feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/---support-or-usage-question.md create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/DOCUMENTATION.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml create mode 100644 .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md deleted file mode 100644 index 8af77a3cac..0000000000 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: "\U0001F41E Bug Report" -about: Report a reproducible bug -title: '' -labels: 'status:possible bug' -assignees: '' - ---- - - - -#### Describe the bug -A clear and concise description of what the bug is. **If your problem is not a bug, please file under Support or Usage Question** - -#### To Reproduce -Code snippet to reproduce, ideally that will work by pasting into something like https://npm.runkit.com/axios, a hosted solution, or a repository that illustrates the issue. **If your problem is not reproducible, please file under Support or Usage Question** - -```js -// Example code here -``` - -#### Expected behavior -A clear and concise description of what you expected to happen. - -#### Environment - - Axios Version [e.g. 0.18.0] - - Adapter [e.g. XHR/HTTP] - - Browser [e.g. Chrome, Safari] - - Browser Version [e.g. 22] - - Node.js Version [e.g. 13.0.1] - - OS: [e.g. iOS 12.1.0, OSX 10.13.4] - - Additional Library Versions [e.g. React 16.7, React Native 0.58.0] - -#### Additional context/Screenshots -Add any other context about the problem here. If applicable, add screenshots to help explain. diff --git a/.github/ISSUE_TEMPLATE/---documentation.md b/.github/ISSUE_TEMPLATE/---documentation.md deleted file mode 100644 index 66dcb03443..0000000000 --- a/.github/ISSUE_TEMPLATE/---documentation.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: "\U0001F4DA Documentation" -about: Report an error or area that needs clarification -title: '' -labels: 'type:documentation' -assignees: '' - ---- - - - -#### Section/Content To Improve -Quote or link to section - -#### Suggested Improvement -Identify what is confusing or incorrect and what could make it better - -#### Relevant File(s) -[e.g. README.md] diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md deleted file mode 100644 index fe5676089c..0000000000 --- a/.github/ISSUE_TEMPLATE/---feature-request.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: "✨ Feature Request" -about: Suggest an idea or feature -title: '' -labels: 'type:feature' -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. diff --git a/.github/ISSUE_TEMPLATE/---support-or-usage-question.md b/.github/ISSUE_TEMPLATE/---support-or-usage-question.md deleted file mode 100644 index e73035fcae..0000000000 --- a/.github/ISSUE_TEMPLATE/---support-or-usage-question.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: "\U0001F914 Support or Usage Question" -about: Get help using Axios -title: '' -labels: 'type:question' -assignees: '' - ---- - - - -#### Describe the issue -A clear and concise description of what the issue is. - -#### Example Code -Code snippet to illustrate your question - -```js -// Example code here -``` - -#### Expected behavior, if applicable -A clear and concise description of what you expected to happen. - -#### Environment - - Axios Version [e.g. 0.18.0] - - Adapter [e.g. XHR/HTTP] - - Browser [e.g. Chrome, Safari] - - Browser Version [e.g. 22] - - Node.js Version [e.g. 13.0.1] - - OS: [e.g. iOS 12.1.0, OSX 10.13.4] - - Additional Library Versions [e.g. React 16.7, React Native 0.58.0] - -#### Additional context/Screenshots -Add any other context about the problem here. If applicable, add screenshots to help explain. diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 0000000000..1a2ae1ac91 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,99 @@ +name: '🐛 Bug Report' +description: Report a reproducible bug. +labels: ['possible bug'] +body: + - type: markdown + attributes: + value: 'Please read and follow the instructions before submitting an issue:' + - type: markdown + attributes: + value: | + - Read all our documentation, especially the [README](https://github.com/axios/axios/blob/master/README.md). It may contain information that helps you solve your issue. + - Ensure your issue isn't already [reported](https://github.com/axios/axios/issues?utf8=%E2%9C%93&q=is%3Aissue). + - If you aren't sure that the issue is caused by Axios or you just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/axios) or [our chat](https://gitter.im/mzabriskie/axios). + - If you're reporting a bug, ensure it isn't already fixed in the latest Axios version. + - type: markdown + attributes: + value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️' + - type: textarea + id: description + attributes: + label: 'Describe the bug' + description: A clear and concise description of what the bug is. **If your problem is not a bug, please file under Support or Usage Question** + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: 'To Reproduce' + description: Code snippet to reproduce, ideally that will work by pasting into something like https://npm.runkit.com/axios, a hosted solution, or a repository that illustrates the issue. **If your problem is not reproducible, please file under Support or Usage Question** + validations: + required: false + - type: textarea + id: code-snippet + attributes: + label: 'Code snippet' + render: js + validations: + required: false + - type: textarea + id: expected + attributes: + label: 'Expected behavior' + description: A clear and concise description of what you expected to happen. + validations: + required: false + - type: markdown + attributes: + value: Environment + - type: input + id: axios-version + attributes: + label: 'Axios Version' + placeholder: 'e.g. 0.18.0' + - type: input + id: adapter-version + attributes: + label: 'Adapter Version' + placeholder: 'e.g. XHR/HTTP' + - type: input + id: browser + attributes: + label: 'Browser' + placeholder: 'e.g. Chrome, Safari' + - type: input + id: browser-version + attributes: + label: 'Browser Version' + placeholder: 'e.g. 42' + - type: input + id: node-version + attributes: + label: 'Node.js Version' + description: 'node --version' + placeholder: 'e.g. 13.0.1' + - type: input + id: os + attributes: + label: 'OS' + placeholder: 'e.g. iOS 16.0.2, OSX 12.6.0' + - type: textarea + id: other-version + attributes: + label: 'Additional Library Versions' + placeholder: | + e.g. + React 16.7, + React Native 0.58.0 + render: bash + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: 'Additional context/Screenshots' + description: Add any other context about the problem here. If applicable, add screenshots to help explain. + render: bash + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/DOCUMENTATION.yml b/.github/ISSUE_TEMPLATE/DOCUMENTATION.yml new file mode 100644 index 0000000000..2b2d7a4863 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/DOCUMENTATION.yml @@ -0,0 +1,30 @@ +name: '📝 Documentation' +description: Report an error or area that needs clarification. +labels: ['documentation'] +body: + - type: markdown + attributes: + value: 'If you found an area that needs clarification, feel free to open a PR or list the section/content that could be improved below' + - type: markdown + attributes: + value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️' + - type: textarea + id: content + attributes: + label: 'Section/Content To Improve' + description: Quote or link to section + validations: + required: true + - type: textarea + id: solution + attributes: + label: 'Suggested Improvement' + description: Identify what is confusing or incorrect and what could make it better + validations: + required: true + - type: textarea + id: files + attributes: + label: 'Relevant File(s)' + placeholder: e.g. README.md + render: bash diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml new file mode 100644 index 0000000000..194bf0e428 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml @@ -0,0 +1,47 @@ +name: '✨ Feature Request' +description: Suggest an idea or feature. +labels: ['feature'] +body: + - type: markdown + attributes: + value: 'Please read and follow the instructions before submitting an issue:' + - type: markdown + attributes: + value: | + - Read all our documentation, especially the [README](https://github.com/axios/axios/blob/master/README.md). It may contain information that helps you solve your issue. + - Ensure your issue isn't already [reported](https://github.com/axios/axios/issues?utf8=%E2%9C%93&q=is%3Aissue). + - If you aren't sure that the issue is caused by Axios or you just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/axios) or [our chat](https://gitter.im/mzabriskie/axios). + - If you're reporting a bug, ensure it isn't already fixed in the latest Axios version. + - type: markdown + attributes: + value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️' + - type: textarea + id: description + attributes: + label: 'Is your feature request related to a problem? Please describe.' + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when [...] + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: false + - type: textarea + id: alternative + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: 'Additional context/Screenshots' + description: Add any other context or screenshots about the feature request here. + render: bash + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.yml b/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.yml new file mode 100644 index 0000000000..e29f08cc2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/SUPPORT_QUESTION.yml @@ -0,0 +1,92 @@ +name: '🤔 Support or Usage Questiont' +description: Get help using Axios. +labels: ['question'] +body: + - type: markdown + attributes: + value: 'Please read and follow the instructions before submitting an issue:' + - type: markdown + attributes: + value: | + - Read all our documentation, especially the [README](https://github.com/axios/axios/blob/master/README.md). It may contain information that helps you solve your issue. + - Ensure your issue isn't already [reported](https://github.com/axios/axios/issues?utf8=%E2%9C%93&q=is%3Aissue). + - If you aren't sure that the issue is caused by Axios or you just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/axios) or [our chat](https://gitter.im/mzabriskie/axios). + - If you're reporting a bug, ensure it isn't already fixed in the latest Axios version. + - type: markdown + attributes: + value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️' + - type: textarea + id: description + attributes: + label: 'Describe the issue' + description: A clear and concise description of what the issue is. + validations: + required: true + - type: textarea + id: example + attributes: + label: 'Example Code' + description: Code snippet to illustrate your question + render: js + validations: + required: false + - type: textarea + id: expected + attributes: + label: 'Expected behavior' + description: A clear and concise description of what you expected to happen. + validations: + required: false + - type: markdown + attributes: + value: Environment + - type: input + id: axios-version + attributes: + label: 'Axios Version' + placeholder: 'e.g. 0.18.0' + - type: input + id: adapter-version + attributes: + label: 'Adapter Version' + placeholder: 'e.g. XHR/HTTP' + - type: input + id: browser + attributes: + label: 'Browser' + placeholder: 'e.g. Chrome, Safari' + - type: input + id: browser-version + attributes: + label: 'Browser Version' + placeholder: 'e.g. 42' + - type: input + id: node-version + attributes: + label: 'Node.js Version' + description: 'node --version' + placeholder: 'e.g. 13.0.1' + - type: input + id: os + attributes: + label: 'OS' + placeholder: 'e.g. iOS 16.0.2, OSX 12.6.0' + - type: textarea + id: other-version + attributes: + label: 'Additional Library Versions' + placeholder: | + e.g. + React 16.7, + React Native 0.58.0 + render: bash + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: 'Additional context/Screenshots' + description: Add any other context about the problem here. If applicable, add screenshots to help explain. + render: bash + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..0086358db1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true From a7126cd93ca92946b0f5f2f0acd744db58dc90b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Legrelle?= Date: Mon, 10 Oct 2022 17:30:13 +0200 Subject: [PATCH 2/3] fix: fix bug report template --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index 1a2ae1ac91..e79dda8c27 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -11,7 +11,7 @@ body: - Read all our documentation, especially the [README](https://github.com/axios/axios/blob/master/README.md). It may contain information that helps you solve your issue. - Ensure your issue isn't already [reported](https://github.com/axios/axios/issues?utf8=%E2%9C%93&q=is%3Aissue). - If you aren't sure that the issue is caused by Axios or you just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/axios) or [our chat](https://gitter.im/mzabriskie/axios). - - If you're reporting a bug, ensure it isn't already fixed in the latest Axios version. + - Ensure it isn't already fixed in the latest Axios version. - type: markdown attributes: value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️' @@ -19,7 +19,7 @@ body: id: description attributes: label: 'Describe the bug' - description: A clear and concise description of what the bug is. **If your problem is not a bug, please file under Support or Usage Question** + description: A clear and concise description of what the bug is. validations: required: true - type: textarea From 1adfa4ca122b0e3ab5e5c0040a78b8c94fe7558d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Legrelle?= Date: Mon, 10 Oct 2022 17:30:57 +0200 Subject: [PATCH 3/3] fix: fix feature request template --- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml index 194bf0e428..0d79af20d6 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml @@ -11,7 +11,6 @@ body: - Read all our documentation, especially the [README](https://github.com/axios/axios/blob/master/README.md). It may contain information that helps you solve your issue. - Ensure your issue isn't already [reported](https://github.com/axios/axios/issues?utf8=%E2%9C%93&q=is%3Aissue). - If you aren't sure that the issue is caused by Axios or you just need help, please use [Stack Overflow](https://stackoverflow.com/questions/tagged/axios) or [our chat](https://gitter.im/mzabriskie/axios). - - If you're reporting a bug, ensure it isn't already fixed in the latest Axios version. - type: markdown attributes: value: '⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️'