mirror of
https://github.com/tenrok/axios.git
synced 2026-05-15 11:59:42 +03:00
chore: update issue template (#5061)
* chore: update issue template * fix: fix bug report template * fix: fix feature request template Co-authored-by: Jay <jasonsaayman@gmail.com>
This commit is contained in:
Félix Legrelle
@@ -1,46 +0,0 @@
|
||||
---
|
||||
name: "\U0001F41E Bug Report"
|
||||
about: Report a reproducible bug
|
||||
title: ''
|
||||
labels: 'status:possible bug'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!-- Click "Preview" for a more readable version --
|
||||
|
||||
Please read and follow the instructions before submitting an issue:
|
||||
|
||||
- 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.
|
||||
- Don't remove any title of the issue template, or it will be treated as invalid by the bot.
|
||||
|
||||
⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️
|
||||
-->
|
||||
|
||||
#### 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.
|
||||
@@ -1,26 +0,0 @@
|
||||
---
|
||||
name: "\U0001F4DA Documentation"
|
||||
about: Report an error or area that needs clarification
|
||||
title: ''
|
||||
labels: 'type:documentation'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!-- Click "Preview" for a more readable version --
|
||||
|
||||
If you found an area that needs clarification, feel free to open a PR or list the section/content that could be improved below
|
||||
|
||||
Don't remove any title of the issue template, or it will be treated as invalid by the bot.
|
||||
|
||||
⚠️👆 Feel free to refer to these instructions before submitting the issue 👆⚠️
|
||||
-->
|
||||
|
||||
#### 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]
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
name: "✨ Feature Request"
|
||||
about: Suggest an idea or feature
|
||||
title: ''
|
||||
labels: 'type:feature'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!-- Click "Preview" for a more readable version --
|
||||
|
||||
Please read and follow the instructions before submitting an issue:
|
||||
|
||||
- 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.
|
||||
- Don't remove any title of the issue template, or it will be treated as invalid by the bot.
|
||||
|
||||
⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️
|
||||
-->
|
||||
|
||||
#### 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.
|
||||
@@ -1,46 +0,0 @@
|
||||
---
|
||||
name: "\U0001F914 Support or Usage Question"
|
||||
about: Get help using Axios
|
||||
title: ''
|
||||
labels: 'type:question'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!-- Click "Preview" for a more readable version --
|
||||
|
||||
Please read and follow the instructions before submitting an issue:
|
||||
|
||||
- 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.
|
||||
- Don't remove any title of the issue template, or it will be treated as invalid by the bot.
|
||||
|
||||
⚠️👆 Feel free to these instructions before submitting the issue 👆⚠️
|
||||
-->
|
||||
|
||||
#### 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.
|
||||
@@ -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).
|
||||
- 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.
|
||||
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
|
||||
|
||||
@@ -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
|
||||
@@ -0,0 +1,46 @@
|
||||
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).
|
||||
- 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
|
||||
@@ -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
|
||||
@@ -0,0 +1 @@
|
||||
blank_issues_enabled: true
|
||||
Reference in New Issue
Block a user