Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update issue template #5061

Merged
merged 4 commits into from Oct 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/---bug-report.md

This file was deleted.

26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/---documentation.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/---feature-request.md

This file was deleted.

46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/---support-or-usage-question.md

This file was deleted.

99 changes: 99 additions & 0 deletions .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).
- 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

30 changes: 30 additions & 0 deletions .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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
@@ -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